Class UserNotificationsClient
Inheritance
System.Object
UserNotificationsClient
Assembly: FastReport.Cloud.SDK.dll
Syntax
public class UserNotificationsClient : object, IUserNotificationsClient
Constructors
UserNotificationsClient(System.Net.Http.HttpClient)
Declaration
public UserNotificationsClient(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
ClearNotifications(ClearNotificationsVM)
Use this endpoint to "clear" your notifications
Declaration
public virtual void ClearNotifications(ClearNotificationsVM body = null)
Parameters
Exceptions
ClearNotificationsAsync(ClearNotificationsVM, System.Threading.CancellationToken)
Use this endpoint to "clear" your notifications
Declaration
public virtual async System.Threading.Tasks.Task ClearNotificationsAsync(ClearNotificationsVM body = null, System.Threading.CancellationToken cancellationToken = null)
Parameters
| Type |
Name |
Description |
| ClearNotificationsVM |
body |
|
| 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 |
Notifications are cleared
|
Exceptions
GetNotifications(Nullable<Int32>, Nullable<Int32>, String)
Use this endpoint to recieve notifications
Declaration
public virtual AuditActionsVM GetNotifications(int? skip = null, int? take = null, string subscriptionId = null)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.Int32> |
skip |
|
| System.Nullable<System.Int32> |
take |
|
| System.String |
subscriptionId |
|
Returns
Exceptions
GetNotificationsAsync(Nullable<Int32>, Nullable<Int32>, String, System.Threading.CancellationToken)
Use this endpoint to recieve notifications
Declaration
public virtual async System.Threading.Tasks.Task<AuditActionsVM> GetNotificationsAsync(int? skip = null, int? take = null, string subscriptionId = null, System.Threading.CancellationToken cancellationToken = null)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.Int32> |
skip |
|
| System.Nullable<System.Int32> |
take |
|
| 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<AuditActionsVM> |
Notifications are getted
|
Exceptions
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<UserNotificationsClient.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 Parameters
Implements