Class AddonCall

Call information of addon

This class is used to get information about the call, the user, the book etc. and to operate with Kitsas Server.

Usually you get an instance of this class in the very first line of the route handlers.

Constructors

constructor

Properties

myConnection request session

Methods

baseUrl businessId connection deleteNotifications get getBook getData getLogs isActive language log logInfo notifications notify officeBusinessId officeId officeName officeType organizationId organizationName replaceNotification rigths saveData set userEmail userId userName userRights

Constructors

constructor

Properties

Private myConnection

myConnection: KitsasConnectionInterface

Private request

request: Request

Private session

session: AddonSession

Methods

baseUrl

  • baseUrl(): string

  • Get the base URL of the service

    Returns string

    Base URL of the service

businessId

  • businessId(): string

  • Organization (book) businessId

    Returns string

    businessId of the organization

connection

  • connection(): KitsasConnectionInterface

  • Get connection to Kitsas Server

    Returns KitsasConnectionInterface

    Connection to Kitsas Server

deleteNotifications

  • deleteNotifications(category?): Promise<void>

  • Delete notifications

    Parameters

    • Optional category: string

      Category of the notification (optional)

    Returns Promise<void>

get

  • get(key): any

  • Get session stored custom data

    Parameters

    • key: string

      Key of the data

    Returns any

    Data or undefined if not found

getBook

  • getBook(): Promise<KitsasBookInterface>

  • Get the book object to interact with the book

    Returns Promise<KitsasBookInterface>

    Book object

getData

  • getData(key): Promise<object>

  • Fetch data stored on the server

    Parameters

    • key: string

      key of the data

    Returns Promise<object>

    data value

getLogs

  • getLogs(): Promise<AddonLogDto[]>

  • Read the log

    Returns Promise<AddonLogDto[]>

    Log entries

isActive

  • isActive(): boolean

  • Is the addon active i.e. does it have rights

    Returns boolean

    True if the addon is active

language

  • language(): string

  • Get language of the call

    Returns string

    Language code

log

  • log(status, message, data?): Promise<void>

  • Weite to the log

    Parameters

    • status: LogStatus

      Status of the action

    • message: string

      Log message

    • Optional data: object

      Additional data

    Returns Promise<void>

logInfo

  • logInfo(): {
        organization: string;
        organizationId: string;
        user: string;
        userId: string;
    }

  • Log information

    Returns {
        organization: string;
        organizationId: string;
        user: string;
        userId: string;
    }

    Log information

    • organization: string
    • organizationId: string
    • user: string
    • userId: string

notifications

  • notifications(): Promise<Notification[]>

  • List notifications

    Returns Promise<Notification[]>

    Notifications

notify

  • notify(type, title, text, category?): Promise<void>

  • Add a notify

    Parameters

    • type: NotificationType

      Notification type

    • title: LanguageString

      Title, in languages

    • text: LanguageString

      Text, in languages

    • Optional category: string

      Category of the notification

    Returns Promise<void>

officeBusinessId

  • officeBusinessId(): string

  • Office businessId

    Returns string

    Business id of the office

officeId

officeName

officeType

  • officeType(): OfficeType

  • Office type

    Returns OfficeType

    Type of the office

organizationId

  • organizationId(): string

  • Organization (book) Id

    Returns string

    Id of the organization

organizationName

  • organizationName(): string

  • Organization (book) name

    Returns string

    Name of the organization

replaceNotification

  • replaceNotification(type, title, text, category): Promise<void>

  • Add or replace notification with same type

    Parameters

    • type: NotificationType

      Notification type

    • title: LanguageString

      Title, in languages

    • text: LanguageString

      Text, in languages

    • category: string

      Category of the notification

    Returns Promise<void>

rigths

  • rigths(): string[]

  • Rights of this sessios

    Returns string[]

    Rights of this session

saveData

  • saveData(key, data): Promise<void>

  • Store data to the server

    Parameters

    • key: string

      key of the data

    • data: object

      data value

    Returns Promise<void>

set

  • set(key, value): void

  • Store custom data to session

    Parameters

    • key: string

      Key of the data

    • value: any

      Data value

    Returns void

userEmail

userId

userName

userRights

  • userRights(): string[]

  • User rights

    Returns string[]

    Rights of the user

Settings

Member Visibility

Theme

On This Page

constructormyConnectionrequestsessionbaseUrlbusinessIdconnectiondeleteNotificationsgetgetBookgetDatagetLogsisActivelanguageloglogInfonotificationsnotifyofficeBusinessIdofficeIdofficeNameofficeTypeorganizationIdorganizationNamereplaceNotificationrigthssaveDatasetuserEmailuserIduserNameuserRights