Class UIModificationsApps

Index

Constructors

constructor

Methods

createUiModification deleteUiModification getUiModifications updateUiModification

Constructors

constructor

new UIModificationsApps(client: Client): Version3.UIModificationsApps
Parameters
- client: Client
Returns Version3.UIModificationsApps
- Defined in src/version3/uIModificationsApps.ts:8

Methods

createUiModification

createUiModification<T = Version3Models.UiModificationIdentifiers>(
parameters: Version3Parameters.CreateUiModification,
callback: Callback<T>,
): Promise<void>
Creates a UI modification. UI modification can only be created by Forge apps.

Each app can define up to 100 UI modifications. Each UI modification can define up to 1000 contexts.

Permissions required:
- None if the UI modification is created without contexts.
- Browse projects project permission for one or more projects, if the UI modification is created with contexts.
Type Parameters
- T = Version3Models.UiModificationIdentifiers
Parameters
- parameters: Version3Parameters.CreateUiModification
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/uIModificationsApps.ts:56
createUiModification<T = Version3Models.UiModificationIdentifiers>(
parameters: Version3Parameters.CreateUiModification,
callback?: undefined,
): Promise<T>
Creates a UI modification. UI modification can only be created by Forge apps.

Each app can define up to 100 UI modifications. Each UI modification can define up to 1000 contexts.

Permissions required:
- None if the UI modification is created without contexts.
- Browse projects project permission for one or more projects, if the UI modification is created with contexts.
Type Parameters
- T = Version3Models.UiModificationIdentifiers
Parameters
- parameters: Version3Parameters.CreateUiModification
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/uIModificationsApps.ts:71

deleteUiModification

deleteUiModification<T = void>(
parameters: string | Version3Parameters.DeleteUiModification,
callback: Callback<T>,
): Promise<void>
Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.

Permissions required: None.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteUiModification
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/uIModificationsApps.ts:144
deleteUiModification<T = void>(
parameters: string | Version3Parameters.DeleteUiModification,
callback?: undefined,
): Promise<T>
Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.

Permissions required: None.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteUiModification
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/uIModificationsApps.ts:154

getUiModifications

getUiModifications<T = Version3Models.PageUiModificationDetails>(
parameters: undefined | Version3Parameters.GetUiModifications,
callback: Callback<T>,
): Promise<void>
Gets UI modifications. UI modifications can only be retrieved by Forge apps.

Permissions required: None.
Type Parameters
- T = Version3Models.PageUiModificationDetails
Parameters
- parameters: undefined | Version3Parameters.GetUiModifications
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/uIModificationsApps.ts:15
getUiModifications<T = Version3Models.PageUiModificationDetails>(
parameters?: Version3Parameters.GetUiModifications,
callback?: undefined,
): Promise<T>
Gets UI modifications. UI modifications can only be retrieved by Forge apps.

Permissions required: None.
Type Parameters
- T = Version3Models.PageUiModificationDetails
Parameters
- Optionalparameters: Version3Parameters.GetUiModifications
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/uIModificationsApps.ts:24

updateUiModification

updateUiModification<T = void>(
parameters: Version3Parameters.UpdateUiModification,
callback: Callback<T>,
): Promise<void>
Updates a UI modification. UI modification can only be updated by Forge apps.

Each UI modification can define up to 1000 contexts.

Permissions required:
- None if the UI modification is created without contexts.
- Browse projects project permission for one or more projects, if the UI modification is created with contexts.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateUiModification
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/uIModificationsApps.ts:104
updateUiModification<T = void>(
parameters: Version3Parameters.UpdateUiModification,
callback?: undefined,
): Promise<T>
Updates a UI modification. UI modification can only be updated by Forge apps.

Each UI modification can define up to 1000 contexts.

Permissions required:
- None if the UI modification is created without contexts.
- Browse projects project permission for one or more projects, if the UI modification is created with contexts.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateUiModification
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/uIModificationsApps.ts:119

Class UIModificationsApps

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.UIModificationsApps

Methods

createUiModification

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteUiModification

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUiModifications

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateUiModification

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page