Interface Release

Hierarchy

ReleaseProps
ReleaseApiMethods
DefaultElements<ReleaseProps>
- Release

Index

Properties

Methods

Properties

entities

entities: BaseCollection<Link<Entity>>

sys

sys: ReleaseSysProps

title

title: string

Methods

delete

delete(): Promise<void>

Inherited from ReleaseApiMethods.delete
- Defined in entities/release.ts:87
Deletes a Release and all ReleaseActions linked to it (non-reversible)

Returns Promise<void>

publish

publish(options?: AsyncActionProcessingOptions): Promise<ReleaseActionProps<"publish">>

Inherited from ReleaseApiMethods.publish
- Defined in entities/release.ts:89
Publishes a Release and waits until the asynchronous action is completed

Parameters
- Optional options: AsyncActionProcessingOptions
Returns Promise<ReleaseActionProps<"publish">>

toPlainObject

toPlainObject(): ReleaseProps

Inherited from DefaultElements.toPlainObject
- Defined in common-types.ts:111
Returns ReleaseProps

unpublish

unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseActionProps<"unpublish">>

Inherited from ReleaseApiMethods.unpublish
- Defined in entities/release.ts:91
Unpublishes a Release and waits until the asynchronous action is completed

Parameters
- Optional options: AsyncActionProcessingOptions
Returns Promise<ReleaseActionProps<"unpublish">>

update

update(payload: ReleasePayload): Promise<Release>

Inherited from ReleaseApiMethods.update
- Defined in entities/release.ts:85
Updates a Release and returns the updated Release object

Parameters
- payload: ReleasePayload
Returns Promise<Release>

validate

validate(__namedParameters?: { options?: AsyncActionProcessingOptions; payload?: ReleaseValidatePayload }): Promise<ReleaseActionProps<"validate">>

Inherited from ReleaseApiMethods.validate
- Defined in entities/release.ts:93
Validates a Release and waits until the asynchronous action is completed

Parameters
- Optional __namedParameters: { options?: AsyncActionProcessingOptions; payload?: ReleaseValidatePayload }
  - Optional options?: AsyncActionProcessingOptions
  - Optional payload?: ReleaseValidatePayload
Returns Promise<ReleaseActionProps<"validate">>