Class BrandingPageBackground

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

Page Background Color or Gradient. Property contains either null to unset, a solid color as a string value #FFFFFF, or a gradient as an object.

{
  type: 'linear-gradient',
  start: '#FFFFFF',
  end: '#000000',
  angle_deg: 35
}

[JsonConverter(typeof(BrandingPageBackground.JsonConverter))]
[Serializable]
public class BrandingPageBackground

Inheritance

object

BrandingPageBackground

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Properties

Type

Type discriminator

[JsonIgnore]
public string Type { get; }

Property Value

string

Value

Union value

[JsonIgnore]
public object? Value { get; }

Property Value

object

Methods

AsMapOfStringToUnknown()

public Dictionary<string, object?> AsMapOfStringToUnknown()

Returns

Dictionary<string, object>

AsString()

Returns the value as a string if Type is 'string', otherwise throws an exception.

public string AsString()

Returns

string

Exceptions

ManagementException

Thrown when Type is not 'string'.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

FromMapOfStringToUnknown(Dictionary<string, object?>)

public static BrandingPageBackground FromMapOfStringToUnknown(Dictionary<string, object?> value)

Parameters

value Dictionary<string, object>

Returns

BrandingPageBackground

FromString(string)

Factory method to create a union from a string value.

public static BrandingPageBackground FromString(string value)

Parameters

value string

Returns

BrandingPageBackground

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

IsMapOfStringToUnknown()

Returns true if Type is "map"

public bool IsMapOfStringToUnknown()

Returns

bool

IsString()

Returns true if Type is "string"

public bool IsString()

Returns

bool

Match<T>(Func<string, T>, Func<Dictionary<string, object?>, T>)

public T Match<T>(Func<string, T> onString, Func<Dictionary<string, object?>, T> onMapOfStringToUnknown)

Parameters

onString Func<string, T>

onMapOfStringToUnknown Func<Dictionary<string, object>, T>

Returns

T

Type Parameters

T

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

TryGetMapOfStringToUnknown(out Dictionary<string, object?>?)

public bool TryGetMapOfStringToUnknown(out Dictionary<string, object?>? value)

Parameters

value Dictionary<string, object>

Returns

bool

TryGetString(out string?)

Attempts to cast the value to a string and returns true if successful.

public bool TryGetString(out string? value)

Parameters

value string

Returns

bool

Visit(Action<string>, Action<Dictionary<string, object?>>)

public void Visit(Action<string> onString, Action<Dictionary<string, object?>> onMapOfStringToUnknown)

Parameters

onString Action<string>

onMapOfStringToUnknown Action<Dictionary<string, object>>

Operators

implicit operator BrandingPageBackground(string)

public static implicit operator BrandingPageBackground(string value)

Parameters

value string

Returns

BrandingPageBackground