Class PromptsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /prompts endpoints.

public class PromptsClient : BaseClient, IPromptsClient

Inheritance

object

BaseClient

PromptsClient

Implements

IPromptsClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.BuildUri(string, IList<Tuple<string, string>>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PromptsClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance on PromptsClient

public PromptsClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

GetAsync(CancellationToken)

Get prompts settings

public 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.

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

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

public 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.

public 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

public 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.

public 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.