Class SmartLinkService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link

Hierarchy

  • CommonHttpService
    • SmartLinkService

Constructors

constructor

Methods

createSmartLink deleteSmartLink getSmartLinkById initialize

Constructors

constructor

  • new SmartLinkService(getClientInstance): SmartLinkService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns SmartLinkService

Methods

createSmartLink

  • createSmartLink(params): Promise<SmartLinkSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

  • Creates a Smart Link in the content tree in the space.

    Permissions required: Permission to view the corresponding space. Permission to create a Smart Link in the content tree in the space.

    Parameters

    • params: {
          requestBody: {
              embedUrl?: string;
              parentId?: string;
              spaceId: string;
              title?: string;
          } & {
              [key: string]: unknown;
          };
      }
      • requestBody: {
            embedUrl?: string;
            parentId?: string;
            spaceId: string;
            title?: string;
        } & {
            [key: string]: unknown;
        }

    Returns Promise<SmartLinkSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

    Returned if the Smart Link was successfully created in the content tree.

    Path

    POST /embeds @scopes-current write:embed:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-post

deleteSmartLink

  • deleteSmartLink(params): Promise<void>

  • Delete a Smart Link in the content tree by id.

    Deleting a Smart Link in the content tree moves the Smart Link to the trash, where it can be restored later

    Permissions required: Permission to view the Smart Link in the content tree and its corresponding space. Permission to delete Smart Links in the content tree in the space.

    Parameters

    • params: {
          id: number;
      }
      • id: number

        The ID of the Smart Link in the content tree to be deleted.

    Returns Promise<void>

    Path

    DELETE /embeds/{id} @scopes-current delete:embed:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-id-delete

getSmartLinkById

  • getSmartLinkById(params): Promise<SmartLinkSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

  • Returns a specific Smart Link in the content tree.

    Permissions required: Permission to view the Smart Link in the content tree and its corresponding space.

    Parameters

    • params: {
          id: number;
          includeCollaborators?: boolean;
          includeDirectChildren?: boolean;
          includeOperations?: boolean;
          includeProperties?: boolean;
      }
      • id: number

        The ID of the Smart Link in the content tree to be returned.

      • OptionalincludeCollaborators?: boolean

        Includes collaborators on the Smart Link.

      • OptionalincludeDirectChildren?: boolean

        Includes direct children of the Smart Link, as defined in the ChildrenResponse object.

      • OptionalincludeOperations?: boolean

        Includes operations associated with this Smart Link in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

      • OptionalincludeProperties?: boolean

        Includes content properties associated with this Smart Link in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

    Returns Promise<SmartLinkSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested Smart Link in the content tree is returned.

    Path

    GET /embeds/{id} @scopes-current read:embed:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-id-get

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