Class LikeService

See

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

Hierarchy

  • CommonHttpService
    • LikeService

Constructors

constructor

Methods

getBlogPostLikeCount getBlogPostLikeUsers getFooterLikeCount getFooterLikeUsers getInlineLikeCount getInlineLikeUsers getPageLikeCount getPageLikeUsers initialize

Constructors

constructor

  • new LikeService(getClientInstance): LikeService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns LikeService

Methods

getBlogPostLikeCount

  • getBlogPostLikeCount(params): Promise<{
        count?: number;
    } & {
        [key: string]: unknown;
    }>

  • Returns the count of likes of specific blog post.

    Permissions required: Permission to view the content of the blog post and its corresponding space.

    Parameters

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

        The ID of the blog post for which like count should be returned.

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

    Returned if the requested count is returned.

    Path

    GET /blogposts/{id}/likes/count @scopes-current read:page:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-blogposts-id-likes-count-get

getBlogPostLikeUsers

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

  • Returns the account IDs of likes of specific blog post.

    Permissions required: Permission to view the content of the blog post and its corresponding space.

    Parameters

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

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • id: number

        The ID of the blog post for which account IDs should be returned.

      • Optionallimit?: number

        Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

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

    Returned if the requested account IDs are returned.

    Path

    GET /blogposts/{id}/likes/users @scopes-current read:page:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-blogposts-id-likes-users-get

getFooterLikeCount

  • getFooterLikeCount(params): Promise<{
        count?: number;
    } & {
        [key: string]: unknown;
    }>

  • Returns the count of likes of specific footer comment.

    Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

    Parameters

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

        The ID of the footer comment for which like count should be returned.

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

    Returned if the requested count is returned.

    Path

    GET /footer-comments/{id}/likes/count @scopes-current read:comment:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-footer-comments-id-likes-count-get

getFooterLikeUsers

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

  • Returns the account IDs of likes of specific footer comment.

    Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

    Parameters

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

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • id: number

        The ID of the footer comment for which like count should be returned.

      • Optionallimit?: number

        Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

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

    Returned if the requested account IDs are returned.

    Path

    GET /footer-comments/{id}/likes/users @scopes-current read:comment:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-footer-comments-id-likes-users-get

getInlineLikeCount

  • getInlineLikeCount(params): Promise<{
        count?: number;
    } & {
        [key: string]: unknown;
    }>

  • Returns the count of likes of specific inline comment.

    Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

    Parameters

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

        The ID of the inline comment for which like count should be returned.

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

    Returned if the requested count is returned.

    Path

    GET /inline-comments/{id}/likes/count @scopes-current read:comment:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-inline-comments-id-likes-count-get

getInlineLikeUsers

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

  • Returns the account IDs of likes of specific inline comment.

    Permissions required: Permission to view the content of the page/blogpost and its corresponding space.

    Parameters

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

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • id: number

        The ID of the inline comment for which like count should be returned.

      • Optionallimit?: number

        Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

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

    Returned if the requested account IDs are returned.

    Path

    GET /inline-comments/{id}/likes/users @scopes-current read:comment:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-inline-comments-id-likes-users-get

getPageLikeCount

  • getPageLikeCount(params): Promise<{
        count?: number;
    } & {
        [key: string]: unknown;
    }>

  • Returns the count of likes of specific page.

    Permissions required: Permission to view the content of the page and its corresponding space.

    Parameters

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

        The ID of the page for which like count should be returned.

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

    Returned if the requested count is returned.

    Path

    GET /pages/{id}/likes/count @scopes-current read:page:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-pages-id-likes-count-get

getPageLikeUsers

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

  • Returns the account IDs of likes of specific page.

    Permissions required: Permission to view the content of the page and its corresponding space.

    Parameters

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

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • id: number

        The ID of the page for which like count should be returned.

      • Optionallimit?: number

        Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

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

    Returned if the requested account IDs are returned.

    Path

    GET /pages/{id}/likes/users @scopes-current read:page:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-pages-id-likes-users-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