Class JobContext

The job and environment context as seen by the agent, accessible by the entrypoint function.

Index

Constructors

Accessors

agent job proc room

Methods

addParticipantEntrypoint addShutdownCallback connect shutdown waitForParticipant

Constructors

constructor

new JobContext(proc, info, room, onConnect, onShutdown): JobContext
Parameters
- proc: JobProcess
- info: RunningJobInfo
- room: Room
- onConnect: (() => void)
  - - (): void
    - Returns void
- onShutdown: ((s) => void)
  - - (s): void
    - Parameters
      s: string
      Returns void
Returns JobContext
- Defined in agents/src/job.ts:63

Accessors

agent

get agent(): undefined | LocalParticipant
Returns undefined | LocalParticipant
The agent's participant if connected to the room, otherwise undefined
- Defined in agents/src/job.ts:94

job

get job(): Job
Returns Job
- Defined in agents/src/job.ts:84

proc

get proc(): JobProcess
Returns JobProcess
- Defined in agents/src/job.ts:80

room

get room(): Room
Returns Room
The room the agent was called into
- Defined in agents/src/job.ts:89

Methods

addParticipantEntrypoint

addParticipantEntrypoint(callback): void
Adds a promise to be awaited whenever a new participant joins the room.
Parameters
- callback: ((job, p) => Promise<void>)
  - - (job, p): Promise<void>
    - Parameters
      job: JobContext
      p: RemoteParticipant
      Returns Promise<void>
Returns void
Throws
FunctionExistsError if an entrypoint already exists
- Defined in agents/src/job.ts:209

addShutdownCallback

addShutdownCallback(callback): void
Adds a promise to be awaited when shutdown is called.
Parameters
- callback: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
Returns void
- Defined in agents/src/job.ts:99

connect

connect(e2ee?, autoSubscribe?, rtcConfig?): Promise<void>
Connects the agent to the room.
Parameters
- Optional e2ee: E2EEOptions
- autoSubscribe: AutoSubscribe = AutoSubscribe.SUBSCRIBE_ALL
- Optional rtcConfig: RtcConfiguration
Returns Promise<void>
Remarks
It is recommended to run this command as early in the function as possible, as executing it later may cause noticeable delay between user and agent joins.

See
@livekit/rtc-node for more information about the parameters.
- Defined in agents/src/job.ts:149

shutdown

shutdown(reason?): void
Gracefully shuts down the job, and runs all shutdown promises.
Parameters
- reason: string = ''
  Optional reason for shutdown
Returns void
- Defined in agents/src/job.ts:185

waitForParticipant

waitForParticipant(identity?): Promise<RemoteParticipant>
Parameters
- Optional identity: string
Returns Promise<RemoteParticipant>
- Defined in agents/src/job.ts:103