Interface ISubscriptionUsersClient

Namespace: FastReport.Cloud

Assembly: FastReport.Cloud.SDK.dll

Syntax

public interface ISubscriptionUsersClient

Methods

AddUser(String, String)

Add a user to the 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

void AddUser(string subscriptionId, string userId)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.String	userId	Idenitifier of user

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Add a user to the 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

System.Threading.Tasks.Task AddUserAsync(string subscriptionId, string userId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.String	userId	Idenitifier of user
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	Succesfully added

Exceptions

Type	Condition
ApiException	A server side error occurred.

CountUsers(String)

Returns a number of users in subscription

Declaration

long CountUsers(string subscriptionId)

Parameters

Type	Name	Description
System.String	subscriptionId

Returns

Type	Description
System.Int64	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

CountUsersAsync(String, System.Threading.CancellationToken)

Returns a number of users in subscription

Declaration

System.Threading.Tasks.Task<long> CountUsersAsync(string subscriptionId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId
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<System.Int64>	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetUsers(String, Nullable<Int32>, Nullable<Int32>)

Returns all users of subscription

Declaration

SubscriptionUsersVM GetUsers(string subscriptionId, int? skip = null, int? take = null)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.Nullable<System.Int32>	skip	How many entities skip
System.Nullable<System.Int32>	take	How many entities take

Returns

Type	Description
SubscriptionUsersVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetUsersAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)

Returns all users of subscription

Declaration

System.Threading.Tasks.Task<SubscriptionUsersVM> GetUsersAsync(string subscriptionId, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.Nullable<System.Int32>	skip	How many entities skip
System.Nullable<System.Int32>	take	How many entities take
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<SubscriptionUsersVM>	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

LeaveSubscripiton(String)

Allows user to leave subscription,.

Declaration

void LeaveSubscripiton(string subscriptionId)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription

Exceptions

Type	Condition
ApiException	A server side error occurred.

LeaveSubscripitonAsync(String, System.Threading.CancellationToken)

Allows user to leave subscription,.

Declaration

System.Threading.Tasks.Task LeaveSubscripitonAsync(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	Succesfully deleted

Exceptions

Type	Condition
ApiException	A server side error occurred.

RemoveUser(String, String)

Delete a user from the 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

void RemoveUser(string subscriptionId, string userId)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.String	userId	Idenitifier of user

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Delete a user from the 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

System.Threading.Tasks.Task RemoveUserAsync(string subscriptionId, string userId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	Idenitifier of subscription
System.String	userId	Idenitifier of user
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	Succesfully deleted

Exceptions

Type	Condition
ApiException	A server side error occurred.