Home Reference Source Repository 
import {ApiUser} from 'ingresse-sdk/src/apis/api.user.js'
public class | source

ApiUser

Extends:

RequestHandler → ApiUser

Ingresse User API

Constructor Summary

Public Constructor
public

constructor(settings: *)

Initialize the Api User

Member Summary

Public Members
public

cookie: *

public

Method Summary

Public Methods
public

Delete the user credentials
public

createUser(data: object, query: object): Promise

Create a new user.
public

Get the user events sessions.
public

Gets the user credentials
public

Get the recent transfers of a user.
public

getUser(id: string | number, query: object): Promise

Get user
public

Get user by ID from
public

Search the users for transfer ticket.
public

Get the new user tickets.
public

getUserPermissions(id: number, query: object): *

Get the user permission.
public

Get user picture
public

getUserSessionTickets(id: *, sessionId: *, query: {}): *

public

Get the user tickets.
public

saveCredentials(userId: number, token: string, jwt: string): Object

Saves the credentials in cookie.
public

search(term: string, query: object): Promise

Search users by term

Inherited Summary

From class RequestHandler
public

auth: *

public
public

delete(path: string, query: object, data: object, headers: object): Promise

Delete resource
public

get(path: string, query: object, headers: object): Promise

Get resource
public

post(path: string, data: object, query: object, headers: object): Promise

Post resource
public

put(path: string, data: object, query: object, headers: object): Promise

Put resource
public

request(options: object): Promise

Create new request promise
public

setEnv(env: string)

Set Environment
public

setUrl(url: string)

Set API url
public

upload(path: string, formData: object, query: object, headers: object): Promise

Upload files

Public Constructors

public constructor(settings: *) source

Initialize the Api User

Override:

RequestHandler#constructor

Params:

NameTypeAttributeDescription
settings *

Public Members

public credentials: {} source

Public Methods

public clearCredentials() source

Delete the user credentials

public createUser(data: object, query: object): Promise source

Create a new user.

Params:

NameTypeAttributeDescription
data object
  • optional

The form with user data for post.
query object
  • optional

Optional request parameters.

Return:

Promise

public getAllUserSessions(id: string | number, query: object): Promise source

Get the user events sessions.

Params:

NameTypeAttributeDescription
id string | number

The user ID to get.
query object
  • optional

Optional request parameters.

Return:

Promise

public getCredentials(): Object source

Gets the user credentials

Return:

Object

public getRecentTransfers(id: number, query: object): Promise source

Get the recent transfers of a user.

Params:

NameTypeAttributeDescription
id number

The user ID to get.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

var id = 123;
var query = {
   size: 12,
   order: 'DESC'
};

ingresse.apiUser.getRecentTransfers(id, query)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getUser(id: string | number, query: object): Promise source

Get user

@DEPRECATED: Use getUserById instead

Params:

NameTypeAttributeDescription
id string | number

The user ID to get.
query object
  • optional

Optional request parameters.

Return:

Promise

public getUserById(id: string, query: object): Promise source

Get user by ID from

Params:

NameTypeAttributeDescription
id string
query object

Return:

Promise

public getUserForTransfer(term: string, query: object): Promise source

Search the users for transfer ticket.

Params:

NameTypeAttributeDescription
term string

The text to search.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

var term = 'Jefferson Silva';
var query = {
   size: 12
};
ingresse.apiUser.getUserForTransfer(term, query)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getUserNewTickets(id: string | number, query: object): Promise source

Get the new user tickets.

Params:

NameTypeAttributeDescription
id string | number

The user ID to get.
query object
  • optional

Optional request parameters.

Return:

Promise

public getUserPermissions(id: number, query: object): * source

Get the user permission.

Params:

NameTypeAttributeDescription
id number

The user id to get.
query object
  • optional

Optional request parameters.
query.context object
  • optional

The context that get user permission. Ex: 'event'
query.contextValue object
  • optional

The contex value. Ex: '123123'
query.resource object
  • optional

The resource type. Ex: 'tickets'.
query.resourceValue object
  • optional

For a specific type of permission. Ex: 'ANY' or 123123.
query.page object
  • optional

The current page with user permission.
query.pageSize object
  • optional

Quantity of permission per page. Default: 25

Return:

*

public getUserPicture(id: string | number, query: object): Promise source

Get user picture

Params:

NameTypeAttributeDescription
id string | number

The user ID to get.
query object
  • optional

Optional request parameters.

Return:

Promise

public getUserSessionTickets(id: *, sessionId: *, query: {}): * source

Params:

NameTypeAttributeDescription
id *
sessionId *
query {}
  • optional
  • default: {}

Return:

*

public getUserTickets(id: string | number, query: object): Promise source

Get the user tickets.

Params:

NameTypeAttributeDescription
id string | number

The user ID to get.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

var userId = 123;
var query = {
   status: 'pending', //Can be [pending, accepted, refused, returned, cancelled].
   pageSize: 10,
   page: currentPage
};

ingresse.apiUser.getUserTicket(userId, query)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public saveCredentials(userId: number, token: string, jwt: string): Object source

Saves the credentials in cookie.

Params:

NameTypeAttributeDescription
userId number

User Id.
token string

The user token.
jwt string

The user jwt token.

Return:

Object

Search users by term

Params:

NameTypeAttributeDescription
term string
query object

Return:

Promise