Users.API

Class: Users

Users

new Users(dispatcher)

Access to the Users resource

Parameters:

Name	Type	Description
dispatcher	Dispatcher	The API dispatcher

Source:

• resources/users.js , lineno 8

Methods

findAll(params) → {Promise}

Returns all users that the dispatcher has access to

Parameters:

Name	Type	Argument	Description
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/users.js , lineno 17

Returns:

The result of the API call

Type

Promise

findById(userId, params) → {Promise}

Finds a user by id

Parameters:

Name	Type	Argument	Description
userId	Number		The user id
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/users.js , lineno 36

Returns:

The result of the API call

Type

Promise

findByWorkspace(workspaceId, params) → {Promise}

Finds a user by workspace

Parameters:

Name	Type	Argument	Description
workspaceId	Number		The workspace id
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/users.js , lineno 47

Returns:

The result of the API call

Type

Promise

me(params) → {Promise}

Returns the current user of the dispatcher

Parameters:

Name	Type	Argument	Description
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/users.js , lineno 26

Returns:

The result of the API call

Type

Promise

Generated with wicked.