pub struct CreateAccountLink<'a> {
    pub account: AccountId,
    pub collect: Option<AccountLinkCollect>,
    pub expand: &'a [&'a str],
    pub refresh_url: Option<&'a str>,
    pub return_url: Option<&'a str>,
    pub type_: AccountLinkType,
}
Expand description

The parameters for AccountLink::create.

Fields

account: AccountId

The identifier of the account to create an account link for.

collect: Option<AccountLinkCollect>

Which information the platform needs to collect from the user.

One of currently_due or eventually_due. Default is currently_due.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

refresh_url: Option<&'a str>

The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid.

The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link’s URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.

return_url: Option<&'a str>

The URL that the user will be redirected to upon leaving or completing the linked flow.

type_: AccountLinkType

The type of account link the user is requesting.

Possible values are account_onboarding or account_update.

Implementations

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more