Method Detail

• getName

  java.lang.String getName()

  Just returns a String - useful for determining whether the App has been exported properly.

  Returns:

  The name of the Plugin.

• getPageApproval

  ApprovalJson getPageApproval(com.atlassian.confluence.user.ConfluenceUser user,
                                   long pageId,
                                   int version)

  Get a Page Approval by it's Page ID and Page Version.

  Parameters:

  user - The Confluence User to get the Approval under. This ensures permissions are upheld.

  pageId - The Confluence Page ID.

  version - The Confluence Page Version to get data about.

  Returns:

  The Approval JSON which contains settings, members and the status of the Page Approval.

• getMacroApproval

  ApprovalJson getMacroApproval(com.atlassian.confluence.user.ConfluenceUser user,
                                    long pageId,
                                    java.lang.String uuid,
                                    java.lang.String macroId,
                                    int version)
                             throws co.uk.automationconsultants.approvals.service.exception.NoPageException,
                                    co.uk.automationconsultants.approvals.service.exception.NoSpacePermissionException,
                                    co.uk.automationconsultants.approvals.service.exception.NoPagePermissionException,
                                    co.uk.automationconsultants.approvals.service.exception.NoPageVersionException,
                                    co.uk.automationconsultants.approvals.service.exception.NoApprovalException

  Get a Macro Approval by it's unique identifiers.

  Parameters:

  user - The Confluence User to get the Approval under. This ensures permissions are upheld.

  pageId - The Confluence Page ID which contains the Macro Approval.

  uuid - The UUID identifies Macro Approvals across Page Versions (it's constant across it's lifetime).

  macroId - The Macro ID, which is unique to the page version containing the Macro.

  version - The Confluence Page Version to get data about.

  Returns:

  The Approval JSON which contains settings, members and the status of the Macro Approval.

  Throws:

  co.uk.automationconsultants.approvals.service.exception.NoPageException - There is no Confluence Page with that ID.

  co.uk.automationconsultants.approvals.service.exception.NoSpacePermissionException - The User specified does not have permissions to access the Space.

  co.uk.automationconsultants.approvals.service.exception.NoPagePermissionException - The User specified does not have permissions to access the Page.

  co.uk.automationconsultants.approvals.service.exception.NoPageVersionException - There isn't a Page Version as specified.

  co.uk.automationconsultants.approvals.service.exception.NoApprovalException - There is no Approval as requested.