Class GenerateLinkOptions

Namespace

Supabase.Gotrue

Assembly

Supabase.Gotrue.dll

Options for Generating an Email Link

public class GenerateLinkOptions

Inheritance

object

GenerateLinkOptions

Derived

GenerateLinkEmailChangeCurrentOptions

GenerateLinkEmailChangeNewOptions

GenerateLinkSignupOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GenerateLinkOptions(LinkType, string)

Constructs options, additional properties may need to be assigned depending on GenerateLinkOptions.LinkType

• NewEmail is required for EmailChangeCurrent and EmailChangeNew
• Password is required for SignUp
• Data is optional for SignUp

public GenerateLinkOptions(GenerateLinkOptions.LinkType linkType, string email)

Parameters

linkType GenerateLinkOptions.LinkType

email string

Properties

Data

A custom data object to store the user's metadata. This maps to the auth.users.user_metadata column.

The data should be a JSON encodable object that includes user-specific info, such as their first and last name.

[JsonProperty("data", NullValueHandling = NullValueHandling.Ignore)]
public Dictionary<string, object>? Data { get; set; }

Property Value

Dictionary<string, object>

Email

The User's Email

[JsonProperty("email", NullValueHandling = NullValueHandling.Ignore)]
public string Email { get; }

Property Value

string

NewEmail

The user's new email. Only required if type is 'email_change_current' or 'email_change_new'.

[JsonProperty("new_email", NullValueHandling = NullValueHandling.Ignore)]
public string? NewEmail { get; set; }

Property Value

string

Password

Only required if generating a signup link.

[JsonProperty("password", NullValueHandling = NullValueHandling.Ignore)]
public string? Password { get; set; }

Property Value

string

RedirectTo

The URL which will be appended to the email link generated.

[JsonIgnore]
public string? RedirectTo { get; set; }

Property Value

string

Type

The type of link being generated

[JsonProperty("type", NullValueHandling = NullValueHandling.Ignore)]
public string Type { get; }

Property Value

string