Class SubscriptionInvitesClient

Inheritance

System.Object

SubscriptionInvitesClient

Implements

ISubscriptionInvitesClient

Namespace: FastReport.Cloud.Client

Assembly: FastReport.Cloud.SDK.dll

Syntax

public class SubscriptionInvitesClient : object, ISubscriptionInvitesClient

Constructors

SubscriptionInvitesClient(System.Net.Http.HttpClient)

Declaration

public SubscriptionInvitesClient(System.Net.Http.HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

JsonSerializerSettings

Declaration

protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

PrepareRequestCallback

Declaration

public Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, string> PrepareRequestCallback { get; set; }

Property Value

Type	Description
Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, System.String>

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AcceptInvite(String, String)

Add a user to the subscription using invite,
the added users will be displayed in the list of users of the subscription,
and these users will also have an active subscription.

Declaration

public virtual void AcceptInvite(string subscriptionId, string accessToken)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.String	accessToken	access token of the subscription

Exceptions

Type	Condition
ApiException	A server side error occurred.

AcceptInviteAsync(String, String, System.Threading.CancellationToken)

Add a user to the subscription using invite,
the added users will be displayed in the list of users of the subscription,
and these users will also have an active subscription.

Declaration

public virtual async System.Threading.Tasks.Task AcceptInviteAsync(string subscriptionId, string accessToken, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.String	accessToken	access token of the subscription
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task	User already in subscription

Exceptions

Type	Condition
ApiException	A server side error occurred.

CreateInvite(String, CreateSubscriptionInviteVM)

Create invite to subscription

Declaration

public virtual SubscriptionInviteVM CreateInvite(string subscriptionId, CreateSubscriptionInviteVM body = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id
CreateSubscriptionInviteVM	body	create VM

Returns

Type	Description
SubscriptionInviteVM	Successfully created

Exceptions

Type	Condition
ApiException	A server side error occurred.

CreateInviteAsync(String, CreateSubscriptionInviteVM, System.Threading.CancellationToken)

Create invite to subscription

Declaration

public virtual async System.Threading.Tasks.Task<SubscriptionInviteVM> CreateInviteAsync(string subscriptionId, CreateSubscriptionInviteVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id
CreateSubscriptionInviteVM	body	create VM
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<SubscriptionInviteVM>	Successfully created

Exceptions

Type	Condition
ApiException	A server side error occurred.

DeleteInvite(String, String)

Delete invite with specified token

Declaration

public virtual void DeleteInvite(string subscriptionId, string accesstoken)

Parameters

Type	Name	Description
System.String	subscriptionId	id
System.String	accesstoken	invite's token

Exceptions

Type	Condition
ApiException	A server side error occurred.

DeleteInviteAsync(String, String, System.Threading.CancellationToken)

Delete invite with specified token

Declaration

public virtual async System.Threading.Tasks.Task DeleteInviteAsync(string subscriptionId, string accesstoken, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id
System.String	accesstoken	invite's token
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task	Successfully deleted

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetInvites(String)

Get list of invites in a subscription,
the added users will be displayed in the list of users of the subscription,
and these users will also have an active subscription.

Declaration

public virtual SubscriptionInvitesVM GetInvites(string subscriptionId)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription

Returns

Type	Description
SubscriptionInvitesVM	Succesfully added

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetInvitesAsync(String, System.Threading.CancellationToken)

Get list of invites in a subscription,
the added users will be displayed in the list of users of the subscription,
and these users will also have an active subscription.

Declaration

public virtual async System.Threading.Tasks.Task<SubscriptionInvitesVM> GetInvitesAsync(string subscriptionId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<SubscriptionInvitesVM>	Succesfully added

Exceptions

Type	Condition
ApiException	A server side error occurred.

ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage, System.Collections.Generic.IReadOnlyDictionary<String, System.Collections.Generic.IEnumerable<String>>, System.Threading.CancellationToken)

Declaration

protected virtual async System.Threading.Tasks.Task<SubscriptionInvitesClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage response, System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IEnumerable<string>> headers, System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>	headers
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<SubscriptionInvitesClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

Implements

ISubscriptionInvitesClient