Interface SessionContextGroup

An instance of a SessionContextGroup

interface SessionContextGroup {
    addContextHandler: (
        handler: OpenFin.ContextHandler,
        contextType?: string,
    ) => Promise<{ unsubscribe: () => void }>;
    getCurrentContext: (type?: string) => Promise<OpenFin.Context>;
    id: string;
    setContext: (context: OpenFin.Context) => Promise<void>;
}

Properties

addContextHandler: (
handler: OpenFin.ContextHandler,
contextType?: string,
) => Promise<{ unsubscribe: () => void }>

A SessionContextGroup instance method for adding a handler for context change.

getCurrentContext: (type?: string) => Promise<OpenFin.Context>

A SessionContextGroup instance method for getting the current context of a certain type.

- (type?: string): Promise<OpenFin.Context>
- Parameters
  - Optionaltype: string
    The Context Type to get. If not specified the last contextType set would get used.
  Returns Promise<OpenFin.Context>

id: string

The SessionContextGroup's id.

setContext: (context: OpenFin.Context) => Promise<void>

A SessionContextGroup instance method for setting a context in the SessionContextGroup.

- (context: OpenFin.Context): Promise<void>
- Parameters
  - context: OpenFin.Context
    The Context to be set.
  Returns Promise<void>