Interface ISubscriptionGroupsClient

Namespace: FastReport.Cloud

Assembly: FastReport.Cloud.SDK.dll

Syntax

public interface ISubscriptionGroupsClient

Methods

CountGroups(String)

Returns a number of groups in subscription

Declaration

long CountGroups(string subscriptionId)

Parameters

Type	Name	Description
System.String	subscriptionId	subscripiton id

Returns

Type	Description
System.Int64	Everything is all right

Exceptions

Type	Condition
ApiException	A server side error occurred.

CountGroupsAsync(String, System.Threading.CancellationToken)

Returns a number of groups in subscription

Declaration

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

Parameters

Type	Name	Description
System.String	subscriptionId	subscripiton id
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>	Everything is all right

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetGroupsList(String, String)

returns groups of the subscription or subscription user

Declaration

GroupsVM GetGroupsList(string subscriptionId, string userId = null)

Parameters

Type	Name	Description
System.String	subscriptionId	subscripiton id
System.String	userId	user Id (optional)

Returns

Type	Description
GroupsVM	Everything is all right (list of groups may be empty)

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

returns groups of the subscription or subscription user

Declaration

System.Threading.Tasks.Task<GroupsVM> GetGroupsListAsync(string subscriptionId, string userId = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	subscripiton id
System.String	userId	user Id (optional)
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<GroupsVM>	Everything is all right (list of groups may be empty)

Exceptions

Type	Condition
ApiException	A server side error occurred.