Class _FrameModule

Lends

Frame

Hierarchy

Base
- _FrameModule

Index

Constructors

Properties

Accessors

Methods

getCurrent getCurrentSync wrap wrapSync

Constructors

constructor

new _FrameModule(wire: Transport<EntityType>): _FrameModule
Parameters
- wire: Transport<EntityType>
Returns _FrameModule

Inherited from Base.constructor

Properties

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from Base.me

Methods

getCurrent

getCurrent(): Promise<Frame>
Asynchronously returns a reference to the current frame

Returns

Tutorial
Frame.getCurrent

Static

Returns Promise<Frame>

getCurrentSync

getCurrentSync(): Frame
Synchronously returns a reference to the current frame

Returns

Tutorial
Frame.getCurrentSync

Static

Returns Frame

wrap

wrap(identity: Identity): Promise<Frame>
Asynchronously returns a reference to the specified frame. The frame does not have to exist

Returns

Tutorial
Frame.wrap

Static
Parameters
- identity: Identity
  
  the identity of the frame you want to wrap
Returns Promise<Frame>

wrapSync

wrapSync(identity: Identity): Frame
Synchronously returns a reference to the specified frame. The frame does not have to exist

Returns

Tutorial
Frame.wrapSync

Static
Parameters
- identity: Identity
  
  the identity of the frame you want to wrap
Returns Frame

Generated using TypeDoc