/AWS1/CL_IVRPARTICIPANTSUMMARY

Summary object describing a participant that has joined a stage.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_participantid TYPE /AWS1/IVRPARTICIPANTID /AWS1/IVRPARTICIPANTID

Unique identifier for this participant, assigned by IVS.

iv_userid TYPE /AWS1/IVRUSERID /AWS1/IVRUSERID

Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

iv_state TYPE /AWS1/IVRPARTICIPANTSTATE /AWS1/IVRPARTICIPANTSTATE

Whether the participant is connected to or disconnected from the stage.

iv_firstjointime TYPE /AWS1/IVRTIME /AWS1/IVRTIME

ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

iv_published TYPE /AWS1/IVRPUBLISHED /AWS1/IVRPUBLISHED

Whether the participant ever published to the stage session.

iv_recordingstate TYPE /AWS1/IVRPARTICIPANTRCINGSTATE /AWS1/IVRPARTICIPANTRCINGSTATE

The participant’s recording state.

iv_replicationtype TYPE /AWS1/IVRREPLICATIONTYPE /AWS1/IVRREPLICATIONTYPE

Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

iv_replicationstate TYPE /AWS1/IVRREPLICATIONSTATE /AWS1/IVRREPLICATIONSTATE

The participant's replication state.

iv_sourcestagearn TYPE /AWS1/IVRSTAGEARN /AWS1/IVRSTAGEARN

Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

iv_sourcesessionid TYPE /AWS1/IVRSTAGESESSIONID /AWS1/IVRSTAGESESSIONID

ID of the session within the source stage, if replicationType is REPLICA.

iv_redundantingest TYPE /AWS1/IVRREDUNDANTINGEST /AWS1/IVRREDUNDANTINGEST

Indicates whether redundant ingest is enabled for the participant.

iv_ingestconfigurationarn TYPE /AWS1/IVRINGESTCONFARN /AWS1/IVRINGESTCONFARN

The participant’s ingest configuration.

---

Queryable Attributes

participantId

Unique identifier for this participant, assigned by IVS.

Accessible with the following methods

Method	Description
GET_PARTICIPANTID()	Getter for PARTICIPANTID, with configurable default
ASK_PARTICIPANTID()	Getter for PARTICIPANTID w/ exceptions if field has no value
HAS_PARTICIPANTID()	Determine if PARTICIPANTID has a value

userId

Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Accessible with the following methods

Method	Description
GET_USERID()	Getter for USERID, with configurable default
ASK_USERID()	Getter for USERID w/ exceptions if field has no value
HAS_USERID()	Determine if USERID has a value

state

Whether the participant is connected to or disconnected from the stage.

Accessible with the following methods

Method	Description
GET_STATE()	Getter for STATE, with configurable default
ASK_STATE()	Getter for STATE w/ exceptions if field has no value
HAS_STATE()	Determine if STATE has a value

firstJoinTime

ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

Accessible with the following methods

Method	Description
GET_FIRSTJOINTIME()	Getter for FIRSTJOINTIME, with configurable default
ASK_FIRSTJOINTIME()	Getter for FIRSTJOINTIME w/ exceptions if field has no value
HAS_FIRSTJOINTIME()	Determine if FIRSTJOINTIME has a value

published

Whether the participant ever published to the stage session.

Accessible with the following methods

Method	Description
GET_PUBLISHED()	Getter for PUBLISHED

recordingState

The participant’s recording state.

Accessible with the following methods

Method	Description
GET_RECORDINGSTATE()	Getter for RECORDINGSTATE, with configurable default
ASK_RECORDINGSTATE()	Getter for RECORDINGSTATE w/ exceptions if field has no valu
HAS_RECORDINGSTATE()	Determine if RECORDINGSTATE has a value

replicationType

Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

Accessible with the following methods

Method	Description
GET_REPLICATIONTYPE()	Getter for REPLICATIONTYPE, with configurable default
ASK_REPLICATIONTYPE()	Getter for REPLICATIONTYPE w/ exceptions if field has no val
HAS_REPLICATIONTYPE()	Determine if REPLICATIONTYPE has a value

replicationState

The participant's replication state.

Accessible with the following methods

Method	Description
GET_REPLICATIONSTATE()	Getter for REPLICATIONSTATE, with configurable default
ASK_REPLICATIONSTATE()	Getter for REPLICATIONSTATE w/ exceptions if field has no va
HAS_REPLICATIONSTATE()	Determine if REPLICATIONSTATE has a value

sourceStageArn

Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

Accessible with the following methods

Method	Description
GET_SOURCESTAGEARN()	Getter for SOURCESTAGEARN, with configurable default
ASK_SOURCESTAGEARN()	Getter for SOURCESTAGEARN w/ exceptions if field has no valu
HAS_SOURCESTAGEARN()	Determine if SOURCESTAGEARN has a value

sourceSessionId

ID of the session within the source stage, if replicationType is REPLICA.

Accessible with the following methods

Method	Description
GET_SOURCESESSIONID()	Getter for SOURCESESSIONID, with configurable default
ASK_SOURCESESSIONID()	Getter for SOURCESESSIONID w/ exceptions if field has no val
HAS_SOURCESESSIONID()	Determine if SOURCESESSIONID has a value

redundantIngest

Indicates whether redundant ingest is enabled for the participant.

Accessible with the following methods

Method	Description
GET_REDUNDANTINGEST()	Getter for REDUNDANTINGEST

ingestConfigurationArn

The participant’s ingest configuration.

Accessible with the following methods

Method	Description
GET_INGESTCONFIGURATIONARN()	Getter for INGESTCONFIGURATIONARN, with configurable default
ASK_INGESTCONFIGURATIONARN()	Getter for INGESTCONFIGURATIONARN w/ exceptions if field has
HAS_INGESTCONFIGURATIONARN()	Determine if INGESTCONFIGURATIONARN has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_PARTICIPANTLIST

TYPES TT_PARTICIPANTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_IVRPARTICIPANTSUMMARY WITH DEFAULT KEY
.