Class AppPropertiesService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-app-properties

Hierarchy

  • CommonHttpService
    • AppPropertiesService

Constructors

constructor

Methods

deleteForgeAppProperty getForgeAppProperties getForgeAppProperty putForgeAppProperty initialize

Constructors

constructor

  • new AppPropertiesService(getClientInstance): AppPropertiesService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns AppPropertiesService

Methods

deleteForgeAppProperty

getForgeAppProperties

  • getForgeAppProperties(params?): Promise<{
        _links?: MultiEntityLinks;
        results?: ({
            key?: string;
            value?: {
                [key: string]: unknown;
            };
        } & {
            [key: string]: unknown;
        })[];
    } & {
        [key: string]: unknown;
    }>

  • Gets Forge app properties. This API can only be accessed using asApp() requests from Forge.

    Parameters

    • params: {
          cursor?: string;
          limit?: number;
      } = {}
      • Optionalcursor?: string

        Used for pagination, this opaque cursor represents the last returned property key. It will be included in the response body as the next link. Use this key to request the next set of results.

      • Optionallimit?: number

        Maximum number of app properties per result to return. If more results exist, use the last returned property key from the Link field in the response body as a cursor to retrieve the next set of results.

    Returns Promise<{
        _links?: MultiEntityLinks;
        results?: ({
            key?: string;
            value?: {
                [key: string]: unknown;
            };
        } & {
            [key: string]: unknown;
        })[];
    } & {
        [key: string]: unknown;
    }>

    Forge app properties returned on success.

    Path

    GET /app/properties @scopes-current read:app-data:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-app-properties#api-app-properties-get

getForgeAppProperty

  • getForgeAppProperty(params): Promise<{
        key?: string;
        value?: {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

  • Gets a Forge app property by property key. This API can only be accessed using asApp() requests from Forge.

    Parameters

    • params: {
          propertyKey: string;
      }
      • propertyKey: string

        The key of the property

    Returns Promise<{
        key?: string;
        value?: {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

    App property returned on success.

    Path

    GET /app/properties/{propertyKey} @scopes-current read:app-data:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-app-properties#api-app-properties-propertykey-get

putForgeAppProperty

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods