Class InvitationsApi

Inheritance

System.Object

InvitationsApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Account.Organizations.Groups.Invitations

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class InvitationsApi

Constructors

InvitationsApi(IBitmovinApiClientFactory)

Declaration

public InvitationsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of InvitationsApi

Declaration

public static BitmovinApiBuilder<InvitationsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<InvitationsApi>

Methods

CreateAsync(String, String, Invitation)

Add Invitation to Group

Declaration

public Task<Invitation> CreateAsync(string organizationId, string groupId, Invitation invitation)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
Invitation	invitation	Invitation details

Returns

Type	Description
System.Threading.Tasks.Task<Invitation>

DeleteAsync(String, String, String)

Delete Invitation

Declaration

public Task<BitmovinResponse> DeleteAsync(string organizationId, string groupId, string invitationId)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
System.String	invitationId	Id of the invitation. (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String, String, String)

Invitation Details

Declaration

public Task<Invitation> GetAsync(string organizationId, string groupId, string invitationId)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
System.String	invitationId	Id of the invitation. (required)

Returns

Type	Description
System.Threading.Tasks.Task<Invitation>

ListAsync(String, String, Func<InvitationsApi.ListQueryParams, InvitationsApi.ListQueryParams>[])

List Invitations

Declaration

public Task<PaginationResponse<Invitation>> ListAsync(string organizationId, string groupId, params Func<InvitationsApi.ListQueryParams, InvitationsApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
System.Func<InvitationsApi.ListQueryParams, InvitationsApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<Invitation>>