Interface IPoliciesClient
Contains functionality to get and update policies.
Namespace: Stylelabs.M.Sdk.Clients
Assembly: Stylelabs.M.Sdk.dll
Syntax
public interface IPoliciesClient
Methods
GetUserGroupPolicyAsync(Int64)
Gets the policy from specified user group.
Declaration
Task<IUserGroupPolicy> GetUserGroupPolicyAsync(long userGroupId)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | userGroupId | Id of the user group to get the policy from. |
Returns
Type | Description |
---|---|
Task<IUserGroupPolicy> | The policy or null when it was not found. |
GetUserPolicyAsync(Int64)
Gets the policy from specified user.
Declaration
Task<IUserPolicy> GetUserPolicyAsync(long userId)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | userId | Id of the user to get the policy from. |
Returns
Type | Description |
---|---|
Task<IUserPolicy> | The policy or null when it was not found. |
UpdateAsync(IPolicy)
Updates the specified policy.
Declaration
Task UpdateAsync(IPolicy policy)
Parameters
Type | Name | Description |
---|---|---|
IPolicy | policy | The policy to update. |
Returns
Type | Description |
---|---|
Task |
Exceptions
Type | Condition |
---|---|
ValidationException | Thrown when the policy could not be saved because a validation error occurred. |
Can we improve this article ? Provide feedback