Class Iteration

Inherit Doc

Hierarchy (view full)

Implements

Constructors

constructor

Properties

appUrl availableOperations changedFields createFields createdAt endDate entityType followerIds groupIds groupMentionIds id labelIds labels memberMentionIds mentionIds name service startDate stats status updatedAt baseUrl

Accessors

teams

Methods

_preSave create delete save update

Constructors

constructor

Properties

appUrl

appUrl: string

availableOperations

availableOperations: ResourceOperation[] = ...

The available operations for the resource, any not in this list will raise an error when called

Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update. It is not recommended to access this property directly.

createFields

createFields: string[] = ...

Fields that are used when creating a new resource

createdAt

createdAt: Date

endDate

endDate: Date

entityType

entityType: string

followerIds

followerIds: string[]

groupIds

groupIds: string[]

groupMentionIds

groupMentionIds: string[]

id

id: number

labelIds

labelIds: number[]

labels

labels: Label[]

memberMentionIds

memberMentionIds: string[]

mentionIds

mentionIds: string[]

name

name: string

service

service: BaseService<BaseResource<default>, default> | BaseSearchableService<BaseResource<default>, default>

startDate

startDate: Date

stats

stats: IterationStats

status

status: IterationStatus

updatedAt

updatedAt: Date

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/iterations'

Accessors

teams

Methods

Protected _preSave

  • _preSave(): Promise<void>
  • Protected

    This method can be overridden by derived classes to perform any necessary operations before saving the resource

    Returns Promise<void>

create

  • create(): Promise<Iteration>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Iteration>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.

Settings

Member Visibility

Theme

On This Page

constructorappUrlavailableOperationschangedFieldscreateFieldscreatedAtendDateentityTypefollowerIdsgroupIdsgroupMentionIdsidlabelIdslabelsmemberMentionIdsmentionIdsnameservicestartDatestatsstatusupdatedAtbaseUrlteams_preSavecreatedeletesaveupdate