Interface ISubscriptionsClient

Namespace: FastReport.Cloud

Assembly: FastReport.Cloud.SDK.dll

Syntax

public interface ISubscriptionsClient

Methods

GetDefaultPermissions(String)

Get subscription's default permissions for new entities

Declaration

DefaultPermissionsVM GetDefaultPermissions(string subscriptionId)

Parameters

Type	Name	Description
System.String	subscriptionId	id

Returns

Type	Description
DefaultPermissionsVM	Successfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetDefaultPermissionsAsync(String, System.Threading.CancellationToken)

Get subscription's default permissions for new entities

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetMyPermissions(String)

Get user's permissions for a subscription by id

Declaration

MyPermissionsVM GetMyPermissions(string subId)

Parameters

Type	Name	Description
System.String	subId	subscription id

Returns

Type	Description
MyPermissionsVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetMyPermissionsAsync(String, System.Threading.CancellationToken)

Get user's permissions for a subscription by id

Declaration

System.Threading.Tasks.Task<MyPermissionsVM> GetMyPermissionsAsync(string subId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subId	subscription 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<MyPermissionsVM>	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetPermissions(String)

Get permissions for a subscription by id

Declaration

SubscriptionPermissionsVM GetPermissions(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
SubscriptionPermissionsVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetPermissionsAsync(String, System.Threading.CancellationToken)

Get permissions for a subscription by id

Declaration

System.Threading.Tasks.Task<SubscriptionPermissionsVM> GetPermissionsAsync(string id, System.Threading.CancellationToken cancellationToken = null)

Parameters

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetSubscription(String)

Returns the subscription by id

Declaration

SubscriptionVM GetSubscription(string id)

Parameters

Type	Name	Description
System.String	id	Identifier of subscription

Returns

Type	Description
SubscriptionVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetSubscriptionAsync(String, System.Threading.CancellationToken)

Returns the subscription by id

Declaration

System.Threading.Tasks.Task<SubscriptionVM> GetSubscriptionAsync(string id, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	Identifier 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<SubscriptionVM>	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetSubscriptions(Nullable<Int32>, Nullable<Int32>)

Returns a list of all subscriptions of current user

Declaration

SubscriptionsVM GetSubscriptions(int? skip = null, int? take = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	skip	Variable for pagination, defautl value is 0
System.Nullable<System.Int32>	take	Variable for pagination, default value is 10

Returns

Type	Description
SubscriptionsVM	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetSubscriptionsAsync(Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)

Returns a list of all subscriptions of current user

Declaration

System.Threading.Tasks.Task<SubscriptionsVM> GetSubscriptionsAsync(int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	skip	Variable for pagination, defautl value is 0
System.Nullable<System.Int32>	take	Variable for pagination, default value is 10
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<SubscriptionsVM>	Succesfully returned

Exceptions

Type	Condition
ApiException	A server side error occurred.

RenameSubscription(String, RenameSubscriptionVM)

Rename subscription

Declaration

SubscriptionVM RenameSubscription(string subscriptionId, RenameSubscriptionVM body)

Parameters

Type	Name	Description
System.String	subscriptionId	id
RenameSubscriptionVM	body	rename VM

Returns

Type	Description
SubscriptionVM	Successfully renamed

Exceptions

Type	Condition
ApiException	A server side error occurred.

RenameSubscriptionAsync(String, RenameSubscriptionVM, System.Threading.CancellationToken)

Rename subscription

Declaration

System.Threading.Tasks.Task<SubscriptionVM> RenameSubscriptionAsync(string subscriptionId, RenameSubscriptionVM body, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id
RenameSubscriptionVM	body	rename 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<SubscriptionVM>	Successfully renamed

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdateDefaultPermissions(String, UpdateDefaultPermissionsVM)

Change subscription's default permissions for new entities

Declaration

DefaultPermissionsVM UpdateDefaultPermissions(string subscriptionId, UpdateDefaultPermissionsVM body)

Parameters

Type	Name	Description
System.String	subscriptionId	id
UpdateDefaultPermissionsVM	body	update default permissions VM

Returns

Type	Description
DefaultPermissionsVM	Successfully changed

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdateDefaultPermissionsAsync(String, UpdateDefaultPermissionsVM, System.Threading.CancellationToken)

Change subscription's default permissions for new entities

Declaration

System.Threading.Tasks.Task<DefaultPermissionsVM> UpdateDefaultPermissionsAsync(string subscriptionId, UpdateDefaultPermissionsVM body, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id
UpdateDefaultPermissionsVM	body	update default permissions 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<DefaultPermissionsVM>	Successfully changed

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdateLocale(String, UpdateSubscriptionLocaleVM)

Update subscription's default locale

Declaration

SubscriptionVM UpdateLocale(string subscriptionId, UpdateSubscriptionLocaleVM body)

Parameters

Type	Name	Description
System.String	subscriptionId	id
UpdateSubscriptionLocaleVM	body	update VM

Returns

Type	Description
SubscriptionVM	Successfully renamed

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdateLocaleAsync(String, UpdateSubscriptionLocaleVM, System.Threading.CancellationToken)

Update subscription's default locale

Declaration

System.Threading.Tasks.Task<SubscriptionVM> UpdateLocaleAsync(string subscriptionId, UpdateSubscriptionLocaleVM body, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id
UpdateSubscriptionLocaleVM	body	update 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<SubscriptionVM>	Successfully renamed

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdatePermissions(String, UpdateSubscriptionPermissionsVM)

Update permissions

Declaration

void UpdatePermissions(string id, UpdateSubscriptionPermissionsVM body = null)

Parameters

Type	Name	Description
System.String	id
UpdateSubscriptionPermissionsVM	body

Exceptions

Type	Condition
ApiException	A server side error occurred.

UpdatePermissionsAsync(String, UpdateSubscriptionPermissionsVM, System.Threading.CancellationToken)

Update permissions

Declaration

System.Threading.Tasks.Task UpdatePermissionsAsync(string id, UpdateSubscriptionPermissionsVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id
UpdateSubscriptionPermissionsVM	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	Succesfully updated

Exceptions

Type	Condition
ApiException	A server side error occurred.