Class FinalLifeCycleManagerBase

Contains operations on the final life cycle status of an Asset.

Inheritance
object
FinalLifeCycleManagerBase
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ModelsClients
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse

public abstract class FinalLifeCycleManagerBase : IFinalLifeCycleManager

Constructors

FinalLifeCycleManagerBase(IMClient)

Declaration
RequestResponse

public FinalLifeCycleManagerBase(IMClient client)
Parameters
TypeNameDescription
IMClientclient

Methods

ApproveAsync(long)

Approves an Asset. State will become Approved.

Declaration
RequestResponse

public abstract Task ApproveAsync(long id)
Parameters
TypeNameDescription
longid

Id of the asset.

Returns
TypeDescription
Task

An awaitable .

Exceptions
TypeCondition
ForbiddenException

When the id is not from an Asset entity.

ForbiddenException

When the transition is not allowed.

ArchiveAsync(long)

Archives an Asset. State will become Archived.

Declaration
RequestResponse

public abstract Task ArchiveAsync(long id)
Parameters
TypeNameDescription
longid

Id of the asset.

Returns
TypeDescription
Task

An awaitable .

Exceptions
TypeCondition
ForbiddenException

When the id is not from an Asset entity.

ForbiddenException

When the transition is not allowed.

DirectPublishAsync(long)

Directly publishes an Asset. State will become Approved.

Declaration
RequestResponse

public abstract Task DirectPublishAsync(long id)
Parameters
TypeNameDescription
longid

Id of the asset.

Returns
TypeDescription
Task

An awaitable .

Exceptions
TypeCondition
ForbiddenException

When the id is not from an Asset entity.

ForbiddenException

When the transition is not allowed.

GetFinalLifeCycleStatusIdAsync(FinalLifeCycleStatus)

Gets the id of a final life cycle status entity.

Declaration
RequestResponse

public Task<long?> GetFinalLifeCycleStatusIdAsync(FinalLifeCycleStatus status)
Parameters
TypeNameDescription
FinalLifeCycleStatusstatus

The status.

Returns
TypeDescription
Task<>long

The id or null when it was not found.

GetFinalLifeCycleStatusIdAsync(string)

Gets the id of a final life cycle status entity.

Declaration
RequestResponse

public Task<long?> GetFinalLifeCycleStatusIdAsync(string status)
Parameters
TypeNameDescription
stringstatus

The status.

Returns
TypeDescription
Task<>long

The id or null when it was not found.

RejectAsync(long, string)

Rejects an Asset. State will become Rejected.

Declaration
RequestResponse

public abstract Task RejectAsync(long id, string reason = null)
Parameters
TypeNameDescription
longid

Id of the asset.

stringreason

The rejection reason.

Returns
TypeDescription
Task

An awaitable .

Exceptions
TypeCondition
ForbiddenException

When the id is not from an Asset entity.

ForbiddenException

When the transition is not allowed.

RestoreAsync(long)

Restores an Asset. State will become Approved.

Declaration
RequestResponse

public abstract Task RestoreAsync(long id)
Parameters
TypeNameDescription
longid

Id of the asset.

Returns
TypeDescription
Task

An awaitable .

Exceptions
TypeCondition
ForbiddenException

When the id is not from an Asset entity.

ForbiddenException

When the transition is not allowed.

SubmitAsync(long)

Submits an Asset. State will become UnderReview.

Declaration
RequestResponse

public abstract Task SubmitAsync(long id)
Parameters
TypeNameDescription
longid

Id of the asset.

Returns
TypeDescription
Task

An awaitable .

Exceptions
TypeCondition
ForbiddenException

When the id is not from an Asset entity.

ForbiddenException

When the transition is not allowed.

Implements

Do you have some feedback for us?

If you have suggestions for improving this article,