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

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.