Interface IPermissionsUriBuilder

An interface for building REST permission-related URIs.

Namespace: Tableau.Migration.Api.Rest

Assembly: Tableau.Migration.dll

Syntax

public interface IPermissionsUriBuilder

Properties

Prefix

Gets the prefix of the URI (i.e. "projects" in /api//sites//projects//permissions).

Declaration

string Prefix { get; }

Property Value

Type	Description
string

Suffix

Gets the suffix of the URI (i.e. "permissions" in /api//sites//projects//permissions).

Declaration

string Suffix { get; }

Property Value

Type	Description
string

Methods

BuildDeleteUri(Guid, ICapability, GranteeType, Guid)

Builds the URI for a permission delete operation. Use BuildUri(Guid) for non-delete operations.

Declaration

string BuildDeleteUri(Guid contentItemId, ICapability capability, GranteeType granteeType, Guid granteeId)

Parameters

Type	Name	Description
Guid	contentItemId	The ID of the content item.
ICapability	capability	The capability to delete.
GranteeType	granteeType	The type of grantee for the capability to delete.
Guid	granteeId	The ID of the grantee for the capability to delete.

Returns

Type	Description
string	The URI string for the permissions URI.

BuildUri(Guid)

Builds the URI for a permission operation. Use BuildDeleteUri(Guid, ICapability, GranteeType, Guid) for delete operations.

Declaration

string BuildUri(Guid contentItemId)

Parameters

Type	Name	Description
Guid	contentItemId	The ID of the content item.

Returns

Type	Description
string	The URI string for the permissions URI.