Class Session

Hierarchy

Session

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Session(url: string, username: string, password: string): Session

- Defined in session.ts:80
Parameters
- url: string
- username: string
- password: string
Returns Session

Properties

Optional authCookie

authCookie?: string

cache

cache: { apps: App[] }

Type declaration

apps: App[]

Optional url

url?: string

Optional xsrf

xsrf?: string

Methods

fetch

fetch(path: string, body?: string, method?: string): Promise<any>

- Defined in session.ts:134
Parameters
- path: string
- Optional body: string
- Optional method: string
Returns Promise<any>

fetchApps

fetchApps(): Promise<App[]>

- Defined in session.ts:235
Fetch the application list

Returns Promise<App[]>

fetchLanguage

fetchLanguage(): Promise<string>

- Defined in session.ts:158
Fetches the user's preferred language

Returns Promise<string>

fetchMessage

fetchMessage(messageId: number): Promise<Message>

- Defined in session.ts:198
Fetches a message from its id

Parameters
- messageId: number
  
  The id of the message
Returns Promise<Message>

fetchMessages

fetchMessages(folder: "Inbox" | "Sent" | "Drafts" | "Trash", page?: number): Promise<Message[]>

- Defined in session.ts:174
Fetches a list of messages from the user

Parameters
- folder: "Inbox" | "Sent" | "Drafts" | "Trash"
  
  The system folder to fetch
- page: number = 0
  
  The messages page
Returns Promise<Message[]>

fetchPinnedApps

fetchPinnedApps(): Promise<App[]>

- Defined in session.ts:251
Fetches the user's pinned apps

Returns Promise<App[]>

fetchUser

fetchUser(userId: string): Promise<User>

- Defined in session.ts:316
Fetches an ENT user by id

Parameters
- userId: string
  
  The id of the user
Returns Promise<User>

fetchUserInfo

fetchUserInfo(): Promise<IUserInfo>

- Defined in session.ts:218
Fetches informations about the current user

Returns Promise<IUserInfo>

Private login

login(): Promise<void>

- Defined in session.ts:91
Fetches a session cookie from the API

Returns Promise<void>

pinApps

pinApps(pins: App[]): Promise<void>

- Defined in session.ts:272
Pins a specific array of applications

Parameters
- pins: App[]
  
  The applications to pin
Returns Promise<void>

searchUsers

searchUsers(query: IQuery): Promise<UserPreview[]>

- Defined in session.ts:295
Searches for user profiles and returns an UserPreview array

Parameters
- query: IQuery
  
  The query
Returns Promise<UserPreview[]>

sendMessage

sendMessage(config: IMessageConfig): Promise<number>

- Defined in session.ts:331
Sends a message to a list of ENT users and returns the message id

Parameters
- config: IMessageConfig
  
  The configuration of the message
Returns Promise<number>

setMood

setMood(mood: string): Promise<void>

- Defined in session.ts:369
Parameters
- mood: string
Returns Promise<void>

Generated using TypeDoc