@greywallsoftware/veoci-js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ApiWeb

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

login

login:

Veoci Login Module

Methods

container

  • container(id: number, containerType?: undefined | string): object

  • Veoci Container Module

    Parameters

    • id: number

      ID of the container for the API calls

    • Optional containerType: undefined | string

    Returns object

    • pageData: function
      • pageData(__namedParameters: object): Promise<any>

      • Gets the page data for the container

        Parameters

        • __namedParameters: object
          • data: object
          • page: string

        Returns Promise<any>

    • searchPeople: function
      • searchPeople(__namedParameters: object): Promise<any>

      • Searches for a person

        Parameters

        • __namedParameters: object
          • allowContacts: boolean
          • allowContainerMemberLists: boolean
          • allowMembersOnly: boolean
          • allowSubscriptionListsOnly: boolean
          • chatId: undefined | number
          • excludeSelf: boolean
          • excludeUsers: boolean
          • includeGroups: boolean
          • includeRoles: boolean
          • requiresAccess: boolean
          • showNoAccess: boolean
          • term: string

        Returns Promise<any>

    • setting: function
      • setting(key: string): object

      • Gets a container setting

        Parameters

        • key: string

          Key of setting

        Returns object

        • get: function
          • get(): Promise<any>
        • remove: function
          • remove(): Promise<any>
        • set: function
          • set(value: string, type: string): Promise<any>
    • SQLBuilder: object
      • composite: object
        • save: function
          • save(data: object): Promise<any>
    • access: object
      • request: function
        • request(reason: string): Promise<any>
    • activities: object
    • checkIns: object
      • notification: function
        • notification(notificationId?: undefined | string): object

        • Parameters

          • Optional notificationId: undefined | string

          Returns object

          • callStatus: function
            • callStatus(): Promise<any>
          • create: function
            • create(data: any): Promise<any>
          • get: function
            • get(forCheckIn?: boolean): Promise<any>

            • Parameters

              • Default value forCheckIn: boolean = false

              Returns Promise<any>

          • respond: function
            • respond(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • responseCode: string
                • responseMode: string

              Returns Promise<any>

          • trigger: function
            • trigger(data: any): Promise<any>
          • update: function
            • update(data: any): Promise<any>
          • validate: function
            • validate(data: any): Promise<any>
      • events: object
        • get: function
          • get(includeSideRooms?: boolean): Promise<any>

          • Parameters

            • Default value includeSideRooms: boolean = false

            Returns Promise<any>

    • files: object
      • createLink: function
        • createLink(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • description: string
            • name: string
            • tag: string
            • url: string

          Returns Promise<any>

      • deleted: function
        • deleted(): Promise<any>
      • file: function
        • file(fileId?: undefined | string): object

        • Parameters

          • Optional fileId: undefined | string

          Returns object

          • clearTags: function
            • clearTags(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • fileIds: string[]

              Returns Promise<any>

          • copy: function
            • copy(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • deleteAfterCopy: boolean
                • destContainerId: string
                • destTagId: undefined | string
                • fileIds: undefined | string[]

              Returns Promise<any>

          • delete: function
            • delete(): Promise<any>
          • rename: function
            • rename(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • name: string

              Returns Promise<any>

          • replaceTag: function
            • replaceTag(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • oldTagId: string
                • tagId: string
                • type: string

              Returns Promise<any>

          • restore: function
            • restore(): Promise<any>
          • setReadOnly: function
            • setReadOnly(viewOnly: string): Promise<any>
          • tag: function
            • tag(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • tagId: string
                • type: string

              Returns Promise<any>

          • untag: function
            • untag(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • tagId: string
                • type: string

              Returns Promise<any>

          • versions: function
            • versions(): Promise<any>
      • folder: function
        • folder(folderId?: undefined | string): object

        • Parameters

          • Optional folderId: undefined | string

          Returns object

          • addFiles: function
            • addFiles(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • fileIds: undefined | string[]
                • removeExistingTags: boolean

              Returns Promise<any>

          • create: function
            • create(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • name: string
                • type: string

              Returns Promise<any>

          • delete: function
            • delete(): Promise<any>
          • rename: function
            • rename(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • name: string

              Returns Promise<any>

          • setPublic: function
            • setPublic(isPub: boolean): Promise<any>
      • folders: function
        • folders(): object

        • Returns object

          • get: function
            • get(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • type: string

              Returns Promise<any>

      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • includeCreators: boolean
            • includeParentContainers: boolean

          Returns Promise<any>

      • restore: function
        • restore(fileId: Array<string>): Promise<any>
      • updateLink: function
        • updateLink(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • description: string
            • linkId: string
            • name: string
            • url: string

          Returns Promise<any>

      • upload: function
        • upload(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • config: object
            • formData: FormData

          Returns Promise<any>

      • bulk: object
        • delete: function
          • delete(fileId: Array<string>): Promise<any>
    • forms: object
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • forView: undefined | string
            • loadFields: undefined | true | false
            • queryBy: string
            • systemTypes: string[]

          Returns Promise<any>

    • history: object
      • get: function
        • get(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • beforeDate: number
            • interval: number

          Returns Promise<any>

    • invitees: object
      • delete: function
        • delete(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • email: undefined | string
            • inviter: undefined | string

          Returns Promise<any>

      • get: function
        • get(): Promise<any>
    • lists: object
      • create: function
        • create(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • addAsMember: boolean
            • create_form: boolean
            • listType: string
            • list_name: string
            • supportsSelfSubscription: boolean

          Returns Promise<any>

      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • includeParents: boolean
            • requiresAccess: boolean

          Returns Promise<any>

      • list: function
        • list(listId: string): object

        • Parameters

          • listId: string

          Returns object

          • addMembers: function
            • addMembers(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • entities: string[]
                • formValues: any[]

              Returns Promise<any>

          • delete: function
            • delete(): Promise<any>
          • removeMembers: function
            • removeMembers(entities: Array<string>): Promise<any>
    • maps: object
      • imageOverlayById: function
        • imageOverlayById(overlayId: number): Promise<any>
      • imageOverlays: function
        • imageOverlays(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • requiresAccess: boolean

          Returns Promise<any>

    • members: object
      • bulk: function
        • bulk(users: Array<string>): object

        • Parameters

          • users: Array<string>

          Returns object

          • update: object
            • pref: function
              • pref(__namedParameters: object): Promise<any>

              • Parameters

                • __namedParameters: object
                  • overwrite: boolean
                  • paramValue: any
                  • preference: string
                  • type: string

                Returns Promise<any>

            • profile: function
              • profile(params: any): Promise<any>
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • excludeSelf: boolean
            • includeLists: boolean

          Returns Promise<any>

      • invite: function
        • invite(params: any): Promise<any>
      • inviteSingle: function
        • inviteSingle(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • memberType: string
            • userId: string

          Returns Promise<any>

      • member: function
        • member(userId: string): object

        • Parameters

          • userId: string

          Returns object

          • updateAccess: function
            • updateAccess(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • access: string

              Returns Promise<any>

          • role: object
            • add: function
              • add(__namedParameters: object): Promise<any>

              • Parameters

                • __namedParameters: object
                  • isPrimary: string | false
                  • roleId: string

                Returns Promise<any>

            • get: function
              • get(type: string): Promise<any>
            • remove: function
              • remove(roleId: string): Promise<any>
      • remove: function
        • remove(entities: Array<string>): Promise<any>
      • roles: object
        • get: function
          • get(): Promise<any>
        • role: function
          • role(roleId: string): object

          • Parameters

            • roleId: string

            Returns object

            • set: function
              • set(users: Array<string>): Promise<any>
        • set: function
          • set(roles: Array<any>): Promise<any>
    • permissions: object
      • get: function
        • get(): Promise<any>
      • set: function
        • set(permissions: Array<string>): Promise<any>
    • plans: object
      • get: function
        • get(): Promise<any>
      • plan: function
        • plan(planId: string): object

        • Parameters

          • planId: string

          Returns object

          • getPlanTemplates: function
            • getPlanTemplates(): Promise<any>
          • launch: function
            • launch(data: object): Promise<any>
          • launchPlanObjects: function
            • launchPlanObjects(data: object, roomId: string, templateId: string): Promise<any>

            • Parameters

              • data: object
              • roomId: string
              • templateId: string

              Returns Promise<any>

    • roomSets: object
      • create: function
        • create(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • attachToChatId: string
            • incident_desc: string
            • incident_name: string

          Returns Promise<any>

      • get: function
        • get(includeRooms: boolean, isOrg?: undefined | true | false): Promise<any>

        • Parameters

          • includeRooms: boolean
          • Optional isOrg: undefined | true | false

          Returns Promise<any>

      • roomSet: function
        • roomSet(roomSetId: string): object

        • Parameters

          • roomSetId: string

          Returns object

          • addRoom: function
            • addRoom(roomId: string): Promise<any>
          • deleteRoom: function
            • deleteRoom(roomId: string): Promise<any>
          • getRooms: function
            • getRooms(): Promise<any>
    • rooms: object
      • create: function
        • create(data: object, groupId: string): Promise<any>
      • delete: function
        • delete(): Promise<any>
      • get: function
        • get(): Promise<any>
      • property: function
        • property(field: string): object

        • Parameters

          • field: string

          Returns object

          • update: function
            • update(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • roomIds: string[]
                • value: any
                • valueKey: any

              Returns Promise<any>

    • sqlReports: object
      • compositeReport: function
        • compositeReport(reportId?: undefined | string): object

        • Parameters

          • Optional reportId: undefined | string

          Returns object

          • create: function
            • create(report: object): Promise<any>
          • get: function
            • get(): Promise<any>
          • update: function
            • update(report: object): Promise<any>
      • get: function
        • get(): Promise<any>
      • report: function
        • report(reportId?: undefined | string): object

        • Parameters

          • Optional reportId: undefined | string

          Returns object

          • create: function
            • create(report: object): Promise<any>
          • delete: function
            • delete(): Promise<any>
          • execute: function
            • execute(params: any): Promise<any>
          • get: function
            • get(): Promise<any>
          • update: function
            • update(report: object): Promise<any>
          • errorRecipients: object
            • get: function
              • get(): Promise<any>
            • set: function
              • set(entityids: Array<string>): Promise<any>
    • views: object
      • get: function
        • get(type: string): Promise<any>
      • view: function
        • view(__namedParameters?: object): object

        • Parameters

          • Default value __namedParameters: object = {}
            • viewId: undefined | string
            • viewKey: undefined | string

          Returns object

          • create: function
            • create(view: any): Promise<any>
          • delete: function
            • delete(): Promise<any>
          • get: function
            • get(): Promise<any>
          • update: function
            • update(view: any): Promise<any>
          • updateName: function
            • updateName(name: string): Promise<any>
    • workflows: object

cronValidate

  • cronValidate(expression: string): Promise<any>

entities

  • entities(id: string): object

  • Parameters

    • id: string

    Returns object

    • get: function
      • get(params?: object): Promise<any>

      • Parameters

        • Default value params: object = {}

        Returns Promise<any>

file

  • file(): object

  • Returns object

    • temp: object
      • rename: function
        • rename(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • id: undefined | string
            • name: string

          Returns Promise<any>

      • upload: function
        • upload(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • contentType: string
            • fileData: string
            • fileName: string

          Returns Promise<any>

firebaseToken

  • firebaseToken(roomId: string): Promise<any>

  • Generates new firebase auth token for the given room

    Parameters

    • roomId: string

    Returns Promise<any>

flightAwareData

  • flightAwareData(__namedParameters: object): Promise<any>

  • Parameters

    • __namedParameters: object
      • airport: string
      • type: string

    Returns Promise<any>

form

  • form(formId: string, containerId: string): object

  • Parameters

    • formId: string
    • containerId: string

    Returns object

    • entry: function
      • entry(entryId?: undefined | string): object

      • Parameters

        • Optional entryId: undefined | string

        Returns object

        • bulkUpdate: function
          • bulkUpdate(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • async: boolean
              • entries: any[]
              • field: string
              • lastModified: any[]
              • value: any

            Returns Promise<any>

        • create: function
          • create(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • formLastModified: any
              • mode: string
              • userConfirm: boolean
              • values: any[]

            Returns Promise<any>

        • delete: function
          • delete(entries?: Array<any>): Promise<any>
        • evaluate: function
          • evaluate(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • canceller: Function
              • values: object

            Returns Promise<any>

        • get: function
          • get(params?: any): Promise<any>
        • recent: function
          • recent(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • _pds: boolean
              • getExportInfo: boolean
              • history: boolean
              • isPublic: boolean
              • outputType: null | string
              • savedViewKey: undefined | string
              • validation: undefined | string

            Returns Promise<any>

        • update: function
          • update(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • entryId: string
              • entryLastModified: any
              • opPeriod: any
              • userConfirm: boolean
              • values: any[]

            Returns Promise<any>

        • links: object
          • create: function
            • create(relatedEntryId: string): Promise<any>
          • delete: function
            • delete(relatedEntryId: string): Promise<any>
          • get: function
            • get(): Promise<any>
        • printView: object
          • get: function
            • get(viewId?: undefined | string): Promise<any>

            • Parameters

              • Optional viewId: undefined | string

              Returns Promise<any>

    • exportToExcel: function
      • exportToExcel(__namedParameters: object): Promise<any>

      • Parameters

        • __namedParameters: object
          • ids: any[]
          • jsonFilters: undefined | string

        Returns Promise<any>

    • removeProperty: function
      • removeProperty(__namedParameters: object): Promise<any>

      • Parameters

        • __namedParameters: object
          • key: string

        Returns Promise<any>

    • setProperty: function
      • setProperty(__namedParameters: object): Promise<any>

      • Parameters

        • __namedParameters: object
          • key: string
          • value: undefined | string

        Returns Promise<any>

    • type: function
      • type(__namedParameters: object): Promise<any>

      • Parameters

        • __namedParameters: object
          • type: undefined | string

        Returns Promise<any>

    • entries: object
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • allData: boolean
            • async: boolean
            • canceller: undefined | Function
            • fieldId: undefined | string
            • filters: undefined | string
            • includeChildEntries: boolean
            • includeChildren: boolean
            • includeDrafts: boolean
            • includeOnlyUserDrafts: boolean
            • includeParents: boolean
            • includeTemplate: boolean
            • outputType: undefined | string
            • parentFormId: undefined | string
            • query: undefined | string
            • sortCol: undefined | string
            • sortDir: undefined | true | false
            • startIndex: undefined | number
            • viewKey: undefined | string

          Returns Promise<any>

      • getMissingEntries: function
        • getMissingEntries(__namedParameters?: object): Promise<any>

        • Use this if fetching specific entries

          Parameters

          • Default value __namedParameters: object = {}
            • entryId: undefined | any[]
            • outputType: undefined | string
            • parentFormId: undefined | string
            • query: undefined | string
            • viewKey: undefined | string

          Returns Promise<any>

      • referenceEntries: function
        • referenceEntries(refFormId: string, fetchParams: object): Promise<any>

        • Parameters

          • refFormId: string
          • fetchParams: object

          Returns Promise<any>

      • search: function
        • search(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • containerId: string
            • formId: undefined | string
            • isPublic: undefined | string
            • parentFormId: undefined | string
            • processId: undefined | string
            • term: string

          Returns Promise<any>

    • imports: object
      • mappableFields: object
        • get: function
          • get(tempFileKey: string): Promise<any>
    • rules: object
      • create: function
        • create(rule: any): Promise<any>
      • delete: function
        • delete(ruleId: string): Promise<any>
      • get: function
        • get(): Promise<any>
      • update: function
        • update(rule: any): Promise<any>
    • structure: object
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • exportInfo: boolean
            • forEntry: boolean
            • includeTemplate: boolean

          Returns Promise<any>

group

  • group(id: number): object

  • Parameters

    • id: number

    Returns object

    • delete: function
      • delete(): Promise<any>
    • details: object
      • get: function
        • get(): Promise<any>
      • update: function
        • update(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • containerSettings: object
            • name: string
            • open: boolean

          Returns Promise<any>

    • integrations: object
      • get: function
        • get(): Promise<any>
      • externalConnections: object
        • create: function
          • create(connection: any): Promise<any>
        • get: function
          • get(): Promise<any>
      • streams: object
        • create: function
          • create(newStream: any): Promise<any>
        • delete: function
          • delete(streamId: string): Promise<any>
        • execute: function
          • execute(streamId: string): Promise<any>
        • get: function
          • get(): Promise<any>
        • update: function
          • update(data: any): Promise<any>
    • workingHours: object
      • get: function
        • get(): Promise<any>
      • save: function
        • save(data: any): Promise<any>

logNavigation

  • logNavigation(path: string): Promise<any>

object

  • object(objectId: string, containerId: string): object

  • Parameters

    • objectId: string
    • containerId: string

    Returns object

    • actions: object
      • evaluate: function
        • evaluate(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • actionId: string
            • parentId: string
            • scheduled: boolean

          Returns Promise<any>

      • get: function
        • get(params: any): Promise<any>
    • relationships: object
    • views: object
      • get: function
        • get(type?: undefined | string): Promise<any>

        • Parameters

          • Optional type: undefined | string

          Returns Promise<any>

org

  • org(id: number): object

  • Veoci Org Module

    Parameters

    • id: number

    Returns object

    : {adminOnly?: boolean}) => Promise}}

    • user: function
      • user(): object

      • Returns object

        • create: function
          • create(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • email: string
              • firstname: string
              • lastname: string
              • memberType: string
              • save_message: boolean
              • send_email: boolean

            Returns Promise<any>

        • invite: function
          • invite(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • email: string
              • memberType: string
              • save_message: boolean

            Returns Promise<any>

    • containers: object
      • deleted: function
        • deleted(): Promise<any>
    • details: object
      • get: function
        • get(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • getSettings: boolean

          Returns Promise<any>

    • excel: object
      • import: function
        • import(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • mapping: any
            • memberContainerPermissions: string[]
            • memberType: string
            • regionCode: string
            • resendInvitesToExisting: boolean
            • sendEmail: boolean
            • skipFirstRow: boolean
            • tempFile: any

          Returns Promise<any>

      • process: function
        • process(tempFileKey: string): Promise<any>
    • groups: object
      • create: function
        • create(data: object): Promise<any>
      • get: function
        • get(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • adminOnly: undefined | true | false

          Returns Promise<any>

      • updatePrimary: function
        • updatePrimary(groupId: string): Promise<any>
    • invites: object
      • addPermissions: function
        • addPermissions(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • emails: string[]
            • groups: string[]

          Returns Promise<any>

      • delete: function
        • delete(emails: Array<string>): Promise<any>
      • get: function
        • get(): Promise<any>
      • inviteSingle: function
        • inviteSingle(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • groupId: string
            • memberType: string
            • userId: string

          Returns Promise<any>

    • mapicons: object
      • delete: function
        • delete(iconId: string): Promise<any>
      • get: function
        • get(): Promise<any>
      • update: function
        • update(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • config: object
            • formData: FormData
            • iconId: string

          Returns Promise<any>

      • upload: function
        • upload(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • config: object
            • formData: FormData

          Returns Promise<any>

plan

  • plan(planId: number): object

room

  • room(id: number): object

  • Veoci Room Module

    Parameters

    • id: number

      ID of the room for API calls

    Returns object

    {{updateChatPreference: ({ key, value, type }: {key: string; value: string; type: string}) => Promise<AxiosResponse>}}

    • archive: function
      • archive(): Promise<any>
    • email: function
      • email(recipients: Array<string>): object

      • Parameters

        • recipients: Array<string>

        Returns object

        • send: function
          • send(__namedParameters: object): Promise<any>

          • Parameters

            • __namedParameters: object
              • body: string
              • customMessage: string
              • isSingleMessage: boolean
              • makePhoneCalls: boolean
              • sendSms: boolean
              • thread: string

            Returns Promise<any>

        • validate: function
          • validate(): Promise<any>
    • join: function
      • join(): Promise<any>
    • restart: function
      • restart(): Promise<any>
    • suspend: function
      • suspend(): Promise<any>
    • updateAcl: function
      • updateAcl(): Promise<any>

      • Similar to join, but only validates the user's access to the room for another interval of time (currently two minutes)

        Returns Promise<any>

    • updateChatPreference: function
      • updateChatPreference(__namedParameters: object): Promise<any>

      • Updates a chat preference

        Parameters

        • __namedParameters: object
          • key: string
          • type: string
          • value: string

        Returns Promise<any>

    • dashboards: object
      • dashboard: function
        • dashboard(dashboardId?: undefined | string): object

        • Parameters

          • Optional dashboardId: undefined | string

          Returns object

          • create: function
            • create(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • dashboardName: string
                • defaultRoomDashboard: boolean
                • isPublic: boolean

              Returns Promise<any>

          • delete: function
            • delete(): Promise<any>
          • update: function
            • update(params: object): Promise<any>

            • dashboardName, defaultRoomDashboard, isPublic associatedSubscriptionListId controlled restricted audience[]

              Parameters

              • params: object

              Returns Promise<any>

          • counts: object
            • get: function
              • get(__namedParameters: object): Promise<any>

              • Parameters

                • __namedParameters: object
                  • _pds: string | false
                  • isPublic: boolean
                  • params: object
                  • tiles: string[]

                Returns Promise<any>

          • parameters: object
            • save: function
              • save(parameters: Array<any>): Promise<any>
          • tiles: object
            • create: function
              • create(props: object): Promise<any>

              • Creates a new tile widget

                Parameters

                • props: object
                  • containerId
                  • containerId: model.get('containerId'),
                  • widgetType: widgetType,
                  • properties: widgetProps,
                  • dashboardComponentWidth
                  • dashboardComponentHeight
                  • expanded
                  • visible
                  • dashboardPublic

                Returns Promise<any>

            • fetchObject: function
              • fetchObject(objectId: string): Promise<any>
            • get: function
              • get(__namedParameters?: object): Promise<any>

              • Parameters

                • Default value __namedParameters: object = {}
                  • groupLevelOnly: boolean
                  • isPublic: boolean

                Returns Promise<any>

            • tile: function
              • tile(tileId?: undefined | string): object

              • Parameters

                • Optional tileId: undefined | string

                Returns object

                • delete: function
                  • delete(): Promise<any>
                • update: function
                  • update(newTile: object): Promise<any>
            • updateOrder: function
              • updateOrder(tileIds: Array<string>): Promise<any>
      • get: function
        • get(): Promise<any>
    • details: object

      Fetch the room details

      • digestSubscribe: function
        • digestSubscribe(subscribe: boolean, type: String, user?: String): Promise<any>

        • Parameters

          • subscribe: boolean
          • type: String
          • Default value user: String = ""

          Returns Promise<any>

      • get: function
        • get(): Promise<any>
      • getProtectionStatus: function
        • getProtectionStatus(): Promise<any>
      • updateName: function
        • updateName(name: string): Promise<any>
      • updateRoomInfo: function
        • updateRoomInfo(data: any): Promise<any>
    • messages: object
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • beforeDate: number
            • interval: string
            • mode: undefined | string

          Returns Promise<any>

      • message: function
        • message(messageId?: undefined | string): object

        • Parameters

          • Optional messageId: undefined | string

          Returns object

          • delete: function
            • delete(): Promise<any>
          • edit: function
            • edit(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • body: string
                • location: undefined | object
                • newThreadId: string
                • oldThreadId: string

              Returns Promise<any>

          • get: function
            • get(): Promise<any>
          • pin: function
            • pin(): Promise<any>
          • send: function
            • send(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • body: string
                • flags: undefined | string[]
                • isNewThread: undefined | true | false
                • newThreadTitle: undefined | string
                • pogi: undefined | string
                • restricted: undefined | true | false
                • thread: undefined | string

              Returns Promise<any>

          • unpin: function
            • unpin(): Promise<any>
          • unthread: function
            • unthread(): Promise<any>
          • updateFlags: function
            • updateFlags(flags: string): Promise<any>
      • store: function
        • store(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • flags: undefined | string[]
            • isNewThread: boolean
            • message: string
            • pogi: undefined | object
            • restricted: boolean
            • thread: undefined | string
            • threadTitle: undefined | string
            • threadType: undefined | string

          Returns Promise<any>

    • notes: object
      • create: function
        • create(newNote: object): Promise<any>
      • delete: function
        • delete(noteId: string): Promise<any>
      • get: function
        • get(): Promise<any>
      • update: function
        • update(note: any): Promise<any>
    • objects: object
      • add: function
        • add(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • access: boolean
            • admin: boolean
            • modify: boolean
            • objectId: string

          Returns Promise<any>

    • operationalPeriods: object
      • get: function
        • get(): Promise<any>
      • update: function
        • update(periods: Array<string>): Promise<any>
    • roles: object
      • get: function
        • get(): Promise<any>
      • getRolesWithMembers: function
        • getRolesWithMembers(): Promise<any>
      • set: function
        • set(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • remove: boolean
            • replace: boolean
            • roleId: string
            • users: string[]

          Returns Promise<any>

    • siderooms: object
      • activity: function
        • activity(): Promise<any>
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • group: string
            • org: string

          Returns Promise<any>

    • status: object
      • get: function
        • get(params?: object): Promise<any>

        • Parameters

          • Default value params: object = {}

          Returns Promise<any>

      • update: function
        • update(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • color: string
            • text: string

          Returns Promise<any>

    • tasks: object
      • delete: function
        • delete(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • tasks: any

          Returns Promise<any>

      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • getSideChatTasks: Boolean
            • savedViewKey: undefined | string

          Returns Promise<any>

      • isOpenToTasks: function
        • isOpenToTasks(): Promise<any>
      • task: function
        • task(): object

        • Returns object

          • create: function
            • create(taskObj: object): Promise<any>
          • statusUpdate: function
            • statusUpdate(status: string, taskId: string): Promise<any>
      • taskTypes: function
        • taskTypes(taskTypeId: string): object

        • Parameters

          • taskTypeId: string

          Returns object

          • get: function
            • get(): Promise<any>
          • tasks: function
            • tasks(__namedParameters?: object): Promise<any>

            • Parameters

              • Default value __namedParameters: object = {}
                • canceller: undefined | Function
                • filters: undefined | string
                • includeChildEntries: boolean
                • outputType: undefined | string
                • viewKey: undefined | string

              Returns Promise<any>

    • threads: object
      • create: function
        • create(__namedParameters: object): Promise<any>

        • Create Thread

          Parameters

          • __namedParameters: object
            • messageId: string
            • messages: string[]
            • title: string

          Returns Promise<any>

      • get: function
        • get(includeSideRooms?: boolean): Promise<any>

        • Parameters

          • Default value includeSideRooms: boolean = false

          Returns Promise<any>

      • history: function
        • history(msgId: string): Promise<any>
      • thread: function
        • thread(threadId: string): object

        • Parameters

          • threadId: string

          Returns object

          • get: function
            • get(): Promise<any>
          • html: function
            • html(): Promise<any>
          • info: function
            • info(): Promise<any>
          • migrate: function
            • migrate(newRoomId: string): Promise<any>
          • tasks: function
            • tasks(): Promise<any>
          • update: function
            • update(__namedParameters: object): Promise<any>

            • Parameters

              • __namedParameters: object
                • color: string
                • location: any
                • name: string
                • state: string
                • type: string

              Returns Promise<any>

          • followers: object
            • add: function
              • add(userId: string): Promise<any>
            • subscribeCurrentUser: function
              • subscribeCurrentUser(): Promise<any>
            • unsubscribeCurrentUser: function
              • unsubscribeCurrentUser(): Promise<any>

search

  • search(__namedParameters: object): Promise<any>

  • Search Veoci

    Parameters

    • __namedParameters: object
      • c: Object

        container

      • cReq: boolean

        container request?

      • ct: Object

        container type

      • n: number

        number of results

      • q: string

        query

      • s: number

        start at

      • siderooms: boolean

        allow siderooms

      • t: Object

        type

    Returns Promise<any>

sessionData

  • sessionData(): Promise<any>

  • Fetches the session data for the logged in user

    Returns Promise<any>

syncTime

  • syncTime(): Promise<Object>

user

  • user(userId?: undefined | number): object

  • Veoci User module

    Parameters

    • Optional userId: undefined | number

      optional for the public methods such as reset password

    Returns object

    • bookmarkedRooms: function
      • bookmarkedRooms(): Promise<any>
    • canShowCreate: function
      • canShowCreate(): Promise<any>
    • changePassword: function
      • changePassword(__namedParameters: object): Promise<any>

      • Parameters

        • __namedParameters: object
          • oldPassword: null | string
          • password: string

        Returns Promise<any>

    • formReviews: function
      • formReviews(): Promise<any>
    • get: function
      • get(browserId: string): Promise<any>
    • orgMembership: function
      • orgMembership(orgId: number): Promise<any>

      • Gets the user's org membership

        Parameters

        • orgId: number

          ID of the org to fetch

        Returns Promise<any>

    • resetPassword: function
      • resetPassword(unameOrEmail: string): Promise<any>
    • rooms: function
      • rooms(__namedParameters: object): Promise<any>

      • Fetch list of user accessible rooms

        Parameters

        • __namedParameters: object
          • limit: string
          • query: string
          • showOlder: boolean

        Returns Promise<any>

    • activity: object
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • beforeDate: number
            • interval: string | number

          Returns Promise<any>

    • alerts: object

      User Alerts Module

      • acknowledge: function
        • acknowledge(alertId: string): Promise<any>
      • batch: function
        • batch(__namedParameters: object): Promise<any>

        • Updates a batch of alerts

          Parameters

          • __namedParameters: object
            • action: string
            • alerts: any

          Returns Promise<any>

      • count: function
        • count(): Promise<any>
      • create: function
        • create(data: Array<string>): Promise<any>

        • Create an alert

          Parameters

          • data: Array<string>

            Request Payload

          Returns Promise<any>

      • get: function
        • get(__namedParameters: object): Promise<any>

        • Get the list of alerts for the user

          Parameters

          • __namedParameters: object
            • count: number
            • includeSideRooms: boolean
            • page: number
            • roomId: null | number
            • state: null | number

          Returns Promise<any>

      • remove: function
        • remove(id: number): Promise<any>

        • Remove an alert

          Parameters

          • id: number

            ID of alert to remove

          Returns Promise<any>

      • update: function
        • update(alert: any): Promise<any>

        • Updates an alert status

          Parameters

          • alert: any

            alert to update

          Returns Promise<any>

    • apps: object
    • assignedCounts: object
    • casRealms: object
      • delete: function
        • delete(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • casUsername: string
            • realm: string

          Returns Promise<any>

      • get: function
        • get(): Promise<any>
    • containers: object
    • dashboard: object
      • get: function
        • get(): Promise<any>
      • tiles: object
        • tile: function
          • tile(tileId?: undefined | string): object

          • Parameters

            • Optional tileId: undefined | string

            Returns object

            • add: function
              • add(__namedParameters: object): Promise<any>

              • Parameters

                • __namedParameters: object
                  • dashboardId: string
                  • objectId: string
                  • tileType: string

                Returns Promise<any>

            • delete: function
              • delete(): Promise<any>
            • share: function
              • share(__namedParameters: object): Promise<any>

              • Parameters

                • __namedParameters: object
                  • dashboardId: string
                  • objectId: string
                  • tileType: string
                  • users: string[]

                Returns Promise<any>

    • files: object
      • get: function
        • get(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • includeCreators: boolean
            • includeHidden: boolean

          Returns Promise<any>

    • googleLogins: object
      • delete: function
        • delete(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • googlePlusId: string

          Returns Promise<any>

      • get: function
        • get(): Promise<any>
      • link: function
        • link(code: object): Promise<any>
    • groups: object

      User Groups module

      • get: function
        • get(): Promise<any>
    • orgs: object

      User Orgs module

      • get: function
        • get(): Promise<any>
    • prefs: object
      • update: function
        • update(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • key: string
            • type: string
            • value: string

          Returns Promise<any>

    • privateMessages: object
      • chat: function
        • chat(entityId: string): object

        • Parameters

          • entityId: string

          Returns object

          • delete: function
            • delete(): Promise<any>
          • find: function
            • find(params?: object): Promise<any>

            • Parameters

              • Default value params: object = {}

              Returns Promise<any>

          • get: function
            • get(): Promise<any>
          • update: function
            • update(): Promise<any>
          • messages: object
            • get: function
              • get(limit: number): Promise<any>
            • send: function
              • send(data: object): Promise<any>
      • decryptionKey: function
        • decryptionKey(): Promise<any>
    • profile: object
      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • orgId: null | string

          Returns Promise<any>

      • removePhoto: function
        • removePhoto(orgId: string): Promise<any>
      • update: function
        • update(profileInfo: object, orgId: string): Promise<any>

        • Parameters

          • profileInfo: object
          • orgId: string

          Returns Promise<any>

    • taskShare: object
      • get: function
        • get(): Promise<any>
      • set: function
        • set(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • enabled: string
            • generateNewKey: string

          Returns Promise<any>

    • tasks: object

      User Tasks Module

      • get: function
        • get(__namedParameters: object): Promise<any>

        • Gets the tasks for a user

          Parameters

          • __namedParameters: object
            • ignoreClosedTasks: boolean
            • type: string

              Type of tasks to fetch (tasksAssigned, tasksCreated, tasksAccess)

          Returns Promise<any>

    • threads: object

      User Threads Module

      • get: function
        • get(__namedParameters: object): Promise<any>

        • Gets the list of user threads

          Parameters

          • __namedParameters: object
            • startDate: any

          Returns Promise<any>

      • remove: function
        • remove(id: number, roomId: number): Promise<any>

        • Removes the

          Parameters

          • id: number
          • roomId: number

          Returns Promise<any>

    • workflows: object
    • xmppSession: object

workflow

  • workflow(workflowId: string, containerId: string): object

  • Parameters

    • workflowId: string
    • containerId: string

    Returns object

    • removeProperty: function
      • removeProperty(__namedParameters: object): Promise<any>

      • Parameters

        • __namedParameters: object
          • key: string

        Returns Promise<any>

    • setProperty: function
      • setProperty(__namedParameters: object): Promise<any>

      • Parameters

        • __namedParameters: object
          • key: string
          • value: undefined | string

        Returns Promise<any>

    • entries: object
      • delete: function
        • delete(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • invocations: any

          Returns Promise<any>

      • exportToExcel: function
        • exportToExcel(__namedParameters: object): Promise<any>

        • Parameters

          • __namedParameters: object
            • filters: any
            • ids: any[]
            • output: string

          Returns Promise<any>

      • get: function
        • get(__namedParameters?: object): Promise<any>

        • Parameters

          • Default value __namedParameters: object = {}
            • canceller: undefined | Function
            • filters: undefined | String
            • fin: undefined | true | false
            • outputType: undefined | string
            • parentFormId: undefined | string
            • viewKey: undefined | string

          Returns Promise<any>

    • paymentToken: object
      • generate: function
        • generate(__namedParameters: object): Promise<any>

        • Generates a payment token via the stripe card token

          Parameters

          • __namedParameters: object
            • email: string
            • fieldId: string
            • invoId: string
            • isPublic: boolean
            • stepId: string
            • token: string

          Returns Promise<any>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc