Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Page

Hierarchy

Implements

Index

Constructors

constructor

  • new Page(pageId: number | string, folderId: number | string, uuid?: undefined | string): Page
  • Starts new page object

    Parameters

    • pageId: number | string
    • folderId: number | string
    • Optional uuid: undefined | string

    Returns Page

Properties

Actions

Actions: IActions

Class for page actions manipulation

type

{IActions}

Content

Page content provider class

type

{IPageContentProvider}

Functions

Functions: IFunctions

Ranges

Class for page range manipulation

type

{IPageRangesCollection}

Private _access

Holds page access values

type

{IUserPageAccess}

Private _accessInterval

_accessInterval: Promise<any>

Object that holds the setInterval object for requesting page access data

type

{number}

Private _accessLoaded

_accessLoaded: boolean = false

Private _checkAccess

_checkAccess: boolean = true

Private _contentLoaded

_contentLoaded: boolean = false

Private _data

_data: IPage

Holds page content and page meta together

type

{IPage}

Private _error

_error: boolean = false

Private _folderId

_folderId: number

Private _folderName

_folderName: string

Private _metaLoaded

_metaLoaded: boolean = false

Private _pageId

_pageId: number

Private _pageName

_pageName: string

Private _provider

_provider: IPageProvider

Object that holds page data provider

type

{IPageProvider}

Private _supportsWS

_supportsWS: boolean = true

Indicates if client supports websockets

type

{boolean}

Private _uuid

_uuid: string

Private _wsDisabled

_wsDisabled: boolean = false

decrypted

decrypted: boolean = true

Indicates if page is decrypted.

type

{boolean}

listeners

listeners: IListeners = []

onListeners

onListeners: any

ready

ready: boolean = false

Indicates when page is ready (both content and settings/meta are loaded)

type

{boolean}

types

types: IPageTypes

Mapping list of page types label - id

type

{IPageTypes}

updatesOn

updatesOn: boolean = true

Indicates if page updates are on - page is requesting/receiving new updates

type

{boolean}

Accessors

EVENT_ACCESS_UPDATED

  • get EVENT_ACCESS_UPDATED(): string
  • Returns string

EVENT_DECRYPTED

  • get EVENT_DECRYPTED(): string
  • Returns string

EVENT_EMPTY_UPDATE

  • get EVENT_EMPTY_UPDATE(): string
  • Returns string

EVENT_ERROR

  • get EVENT_ERROR(): string
  • Returns string

EVENT_NEW_CONTENT

  • get EVENT_NEW_CONTENT(): string
  • Returns string

EVENT_NEW_CONTENT_DELTA

  • get EVENT_NEW_CONTENT_DELTA(): string
  • Returns string

EVENT_NEW_META

  • get EVENT_NEW_META(): string
  • Returns string

EVENT_RANGES_UPDATED

  • get EVENT_RANGES_UPDATED(): string
  • Returns string

EVENT_READY

  • get EVENT_READY(): string
  • Returns string

TYPE_ALERT

  • get TYPE_ALERT(): number
  • Returns number

TYPE_DOMAIN_USAGE_REPORT

  • get TYPE_DOMAIN_USAGE_REPORT(): number
  • Returns number

TYPE_GLOBAL_USAGE_REPORT

  • get TYPE_GLOBAL_USAGE_REPORT(): number
  • Returns number

TYPE_LIVE_USAGE_REPORT

  • get TYPE_LIVE_USAGE_REPORT(): number
  • Returns number

TYPE_PAGE_ACCESS_REPORT

  • get TYPE_PAGE_ACCESS_REPORT(): number
  • Returns number

TYPE_PAGE_UPDATE_REPORT

  • get TYPE_PAGE_UPDATE_REPORT(): number
  • Returns number

TYPE_PDF

  • get TYPE_PDF(): number
  • Returns number

TYPE_REGULAR

  • get TYPE_REGULAR(): number
  • Returns number

access

  • Getter for page access

    Returns IUserPageAccess

data

  • Getter for page data

    Returns IPage

encryptionKeyPull

  • Setter for pull encryption key

    Parameters

    Returns void

encryptionKeyPush

  • Setter for push encryption key

    Parameters

    Returns void

Methods

canEdit

  • canEdit(): boolean
  • Returns boolean

Private checkPageAccess

  • checkPageAccess(): void
  • Returns void

Private checkReady

  • checkReady(): void
  • Check if page is considered to be ready

    Returns void

clone

  • Clone current page. Clones page content and some settings, can specify more options via options param.

    deprecated

    Parameters

    Returns Promise<IPageService>

copy

  • Clone current page. Clones page content and some settings, can specify more options via options param.

    Parameters

    Returns Promise<IPageService>

Private createProvider

  • createProvider(ignoreWS?: undefined | false | true): void
  • Parameters

    • Optional ignoreWS: undefined | false | true

    Returns void

decrypt

  • Check if page is encrypted and decrypt it if it is

    Parameters

    Returns void

del

  • del(): Promise<any>
  • Deletes current page

    Returns Promise<any>

destroy

  • destroy(): void
  • Destroy page object

    Returns void

emit

  • emit(name: string, args?: any): void
  • Parameters

    • name: string
    • Optional args: any

    Returns void

Private encrypt

  • Encrypt page content with given key

    Parameters

    Returns string | null

Private getPageAccess

  • getPageAccess(): Promise<any>
  • Load page access

    Returns Promise<any>

Private getPageId

  • getPageId(folderName: string, pageName: string): Promise<any>
  • In case page is requested with name, get page ID from service

    Parameters

    • folderName: string
    • pageName: string

    Returns Promise<any>

Private init

  • init(ignoreWS?: undefined | false | true): void
  • Actual bootstrap of the page, starts page updates, registeres provider, starts page access updates

    Parameters

    • Optional ignoreWS: undefined | false | true

    Returns void

off

  • off(name: string, callback: any): void
  • Parameters

    • name: string
    • callback: any

    Returns void

on

  • on(name: string, callback: any): void
  • Parameters

    • name: string
    • callback: any

    Returns void

Private onPageError

  • onPageError(err: any): void
  • Parameters

    • err: any

    Returns void

push

  • push(forceFull?: boolean, otherRequestData?: any): Promise<any>
  • Push new data to a page. This method accepts either full page content or delta content update

    Parameters

    • Default value forceFull: boolean = false
    • Default value otherRequestData: any = {}

    Returns Promise<any>

Private pushDelta

  • pushDelta(data: IPageDelta, otherRequestData?: any): Promise<any>
  • Push delta content update

    Parameters

    • data: IPageDelta
    • Default value otherRequestData: any = {}

    Returns Promise<any>

Private pushFull

  • pushFull(content: IPageContent, otherRequestData?: any): Promise<any>
  • Push full content update

    Parameters

    • content: IPageContent
    • Default value otherRequestData: any = {}

    Returns Promise<any>

register

  • register(callback: any): void
  • Parameters

    • callback: any

    Returns void

Private registerListeners

  • registerListeners(): void
  • Register listeners. THese are listeners on events emitted from page providers, which are processed and then re-emitted to public

    Returns void

removeEvent

  • removeEvent(): void

removeEvents

  • removeEvents(): void

saveMeta

  • saveMeta(data: any): Promise<any>
  • Save page settings/meta

    Parameters

    • data: any

    Returns Promise<any>

setAsFoldersDefault

  • setAsFoldersDefault(): Promise<any>
  • Sets current page as folders default for current user

    Returns Promise<any>

start

  • start(): void
  • Start page updates

    Returns void

stop

  • stop(): void
  • Stop page updates

    Returns void

unRegister

  • unRegister(callback: any): void
  • Parameters

    • callback: any

    Returns void

Private updatePageType

  • updatePageType(pageType: number): number
  • Temporary fix to update page types. This will take any page report types and adds 1000 to them. This way can do easier filtering.

    Parameters

    • pageType: number

    Returns number

Static create

  • create(folderId: number, name: string, type?: number, template?: IPageTemplate, organization_public?: boolean): Promise<IPageService>
  • Creates new page in the system

    Parameters

    • folderId: number
    • name: string
    • Default value type: number = 0
    • Optional template: IPageTemplate
    • Default value organization_public: boolean = false

    Returns Promise<IPageService>

Object literals

Private _encryptionKeyPull

_encryptionKeyPull: object

name

name: string = ""

passphrase

passphrase: string = ""

Private _encryptionKeyPush

_encryptionKeyPush: object

name

name: string = ""

passphrase

passphrase: string = ""

Generated using TypeDoc