W-CF Documentation - v11.0.0
    Preparing search index...

    Class EaiwsSession

    Hierarchy (View Summary)

    Index
    eventConnected: ListenableEvent<void, EaiwsSession> = ...

    Will be triggered if this instance was connected to an EAIWS session.

    eventDisconnected: ListenableEvent<void, EaiwsSession> = ...

    Will be triggered if this instance was disconnected from an EAIWS session.

    • get baseUrl(): string

      Returns string

    • get isValid(): boolean

      Returns boolean

    • get owner(): EaiwsSession

      Returns the EAIWS session instance which owns this context.

      Returns EaiwsSession

    • get sessionId(): string

      ID of the current session context. If this instance is a EaiwsSession then this ID is the ID of the main EAIWS session.

      Returns string

    • Closes the currently connected EAIWS session and disconnects.

      Returns Promise<boolean>

    • Connects to an already opened EAIWS session. If pKeepAliveInterval is null or 0 the keep alive handling will be disabled (default: 60000).

      Parameters

      • pBaseUrl: string
      • pSessionId: string
      • pKeepAliveInterval: number | null = 60000

      Returns boolean

    • Parameters

      • pUrl: string

      Returns Promise<void>

    • Disconnects from the currently connected EAIWS session. The session will not be closed.

      Returns boolean

    • Opens and connects a new EAIWS session.

      Parameters

      Returns Promise<boolean>

    • Parameters

      • pType: SessionCacheFileType
      • pFile: Blob
      • OptionalpOnProgress: (pEvent: ProgressEvent, pXhr: XMLHttpRequest) => any
      • OptionalpUrlSuffix: string
      • OptionalpArchiveType: "UnixAR"

      Returns Promise<string | null>

    • Uploads the given file to the provided EAIWS upload URL. Note: If a progress callback is provided the request is performed using XmlHttpRequest otherwise using fetch.

      Parameters

      • pTargetUrl: string
      • pFile: Blob
      • OptionalpOnProgress: (pEvent: ProgressEvent, pXhr: XMLHttpRequest) => any

      Returns Promise<string>

      Returns the used upload url.