Interface GetSchemaPermissionsOptions

interface GetSchemaPermissionsOptions {
    containerPath?: string;
    failure?: RequestFailure<any>;
    schemaName: "study";
    scope?: any;
    success?: RequestSuccess<SchemaPermissionsResponse>;
}

Hierarchy (view full)

Properties

containerPath? failure? schemaName scope? success?

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.

schemaName

schemaName: "study"

Name of the schema to retrieve information on. Currently only works for "study".

Optional scope

scope?: any

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

Optional success

success?: RequestSuccess<SchemaPermissionsResponse>

This will be called upon successfully completing a request.

Settings

Member Visibility

Theme

On This Page

containerPathfailureschemaNamescopesuccess

Generated using TypeDoc