Interface GetUserPermissionsOptions

interface GetUserPermissionsOptions {
    containerPath?: string;
    failure?: RequestFailure<any>;
    includeSubfolders?: boolean;
    scope?: any;
    success?: RequestSuccess<GetUserPermissionsResponse>;
    userEmail?: string;
    userId?: number;
}

Hierarchy (view full)

Properties

containerPath? failure? includeSubfolders? scope? success? userEmail? userId?

Properties

Optional containerPath

containerPath?: string

An alternate container path to get permissions from. If not specified, the current container path will be used.

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optional includeSubfolders

includeSubfolders?: boolean

Set to true to recurse down the subfolders (defaults to false)

Optional scope

scope?: any

A scoping object for the success and failure callback functions (default to this).

Optional success

success?: RequestSuccess<GetUserPermissionsResponse>

This will be called upon successfully completing a request.

Optional userEmail

userEmail?: string

The email address (user name) of the user (specify only userId or userEmail, not both)

Optional userId

userId?: number

The id of the user. Omit to get the current user's information

Settings

Member Visibility

Theme

On This Page

containerPathfailureincludeSubfoldersscopesuccessuserEmailuserId

Generated using TypeDoc