Class SubscriptionGroupsClient
Inheritance
System.Object
SubscriptionGroupsClient
Implements
Namespace: FastReport.Cloud.Client
Assembly: FastReport.Cloud.SDK.dll
Syntax
public class SubscriptionGroupsClient : object, ISubscriptionGroupsClientConstructors
SubscriptionGroupsClient(System.Net.Http.HttpClient)
Declaration
public SubscriptionGroupsClient(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
CountGroups(String)
Returns a number of groups in subscription
Declaration
public virtual 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
public virtual async 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
public virtual 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
public virtual async 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. |
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<SubscriptionGroupsClient.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<SubscriptionGroupsClient.ObjectResponseResult<T>> |
Type Parameters
| Name | Description |
|---|---|
| T |