Interface IPromptsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

public interface IPromptsClient

Methods

GetAsync(CancellationToken)

Get prompts settings

Task<Prompt> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Prompt>

A Prompt instance containing the information about the prompt settings.

Remarks

Get prompts settings

GetCustomTextForPromptAsync(string, string, CancellationToken)

Retrieve custom text for a specific prompt and language.

Task<object> GetCustomTextForPromptAsync(string promptName, string language, CancellationToken cancellationToken = default)

Parameters

promptName string

Name of the prompt.

language string

Language to update.

cancellationToken CancellationToken

CancellationToken

Returns

Task<object>

An object containing custom dictionaries for a group of screens.

GetPartialsAsync(string, CancellationToken)

Get template partials for a prompt

Task<object> GetPartialsAsync(string promptName, CancellationToken cancellationToken = default)

Parameters

promptName string

Name of the prompt.

cancellationToken CancellationToken

CancellationToken

Returns

Task<object>

An object containing template partials for a group of screens.

SetCustomTextForPromptAsync(string, string, object, CancellationToken)

Set custom text for a specific prompt. Existing texts will be overwritten.

Task SetCustomTextForPromptAsync(string promptName, string language, object customText, CancellationToken cancellationToken = default)

Parameters

promptName string

Name of the prompt.

language string

Language to update.

customText object

An object containing custom dictionaries for a group of screens.

cancellationToken CancellationToken

CancellationToken

Returns

Task

SetPartialsAsync(string, object, CancellationToken)

Set template partials for a prompt

Task SetPartialsAsync(string promptName, object partials, CancellationToken cancellationToken = default)

Parameters

promptName string

Name of the prompt.

partials object

An object containing template partials for a group of screens.

cancellationToken CancellationToken

CancellationToken

Returns

Task

UpdateAsync(PromptUpdateRequest, CancellationToken)

Update prompts settings.

Task<Prompt> UpdateAsync(PromptUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request PromptUpdateRequest

Specifies prompt setting values that are to be updated.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Prompt>

The Prompt that was updated.

Remarks

Update prompts settings.