Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This feature is available starting with v1.1.0 of the Power Scripts™ for Confluence.
Info
titleAvailability
Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

addUserToContentPermission(permissionType, pageId, userNameOrKey)

Package

Alias

Pkg Usage

Description

 Adds
Excerpt
hiddentrue
Adds a single user to a content permission if the user is not already in that permission.

Adds a single user to a content permission if the user is not already in that permission.

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

permissionType

...

String

Yes

Permission type a user will be added to.

...

A list of values is provided in a table below.

pageId

...

Number

Yes

The ID of the page to add permission to.

userNameOrKey

...

String

Yes

User name or key of a user to add in

...

permission

...

.

Return

...

Type

boolean Boolean (true/false)

Returns true if the content permission was actually changed by the routine invocation, that is a user was actually added to the specified content permission.
Returns false if a content permission was not changed.

Note

If the routine returns false, it doesn't mean that a user doesn't have the specified permission. It just means that the state of the content permission was not changed. For example, if the specified user was in the specified content permission before the routine invocation, the routine will return false, because the state of the content permission was not changed. In order to check if the specified user has a certain content permission please use the following routine: userHasContentPermission.

Example

Allows the "jdoe" user to modify page with the 11508 ID.

...

Example

Code Block
languagejs
addUserToContentPermission("Edit", 11508, "jdoe");

...

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "psuser_conf"routines" and space = currentSpace ( )
labelsjiraarray_comment_routineroutines