Class FormsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

public class FormsClient : BaseClient, IFormsClient

Inheritance

object

BaseClient

FormsClient

Implements

IFormsClient

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

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

Initializes a new instance of FormsClient.

public FormsClient(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

CreateAsync(FormCreateRequest, CancellationToken)

Create a form.

public Task<Form> CreateAsync(FormCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request FormCreateRequest

FormCreateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<Form>

DeleteAsync(string, CancellationToken)

Delete a form.

public Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

ID of the form to be deleted

cancellationToken CancellationToken

Returns

Task

GetAllAsync(FormsGetRequest, CancellationToken)

Get all Forms

public Task<IPagedList<FormBase>> GetAllAsync(FormsGetRequest request, CancellationToken cancellationToken = default)

Parameters

request FormsGetRequest

FormsGetRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<IPagedList<FormBase>>

All available Forms.

GetAsync(FormsGetRequest, CancellationToken)

Get A form.

public Task<Form> GetAsync(FormsGetRequest request, CancellationToken cancellationToken = default)

Parameters

request FormsGetRequest

FormsGetRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<Form>

All available Forms.

UpdateAsync(string, FormUpdateRequest, CancellationToken)

Update a form.

public Task<Form> UpdateAsync(string id, FormUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

ID of the form to be updated

request FormUpdateRequest

FormUpdateRequest

cancellationToken CancellationToken

Returns

Task<Form>