Event Triggers

You can pass a function to the onJoinCall, onMemberJoin, onMemberLeave or onLeaveCall props to trigger on those particular events. For example, console.log("call ended") triggers by default for onLeaveCall.

xxxxxxxxxx

    <CatalystChat

            room="ROOM_NAME"

            appId="YOUR_CATALYST_PROJECT_ID"

            onJoinCall={ENTER_FUNCTION_HERE}

            onMemberJoin={ENTER_FUNCTION_HERE}

            onMemberLeave={ENTER_FUNCTION_HERE}

            onLeaveCall={ENTER_FUNCTION_HERE}

        />

Passing Arbitrary Data

You can also pass any kind of encoded stringified data through Catalyst from one member to another. For example, if you need to transmit some form of metadata between members of a call without setting up your own servers. This is particularly useful for synchronizing state or triggering custom events.

This can be done with a combination of the arbData and handleReceiveArbData props:

xxxxxxxxxx

    const textEncoder = new TextEncoder()

    const textDecoder = new TextDecoder();

    let sampleJSONData = {

        text: 'Catalyst is awesome!'

    }

    let sampleStrData = JSON.stringify(sampleJSONData);

    let sampleArbData = textEncoder.encode(sampleStrData)

​

    <CatalystChat

            room="ROOM_NAME"

            appId="YOUR_CATALYST_PROJECT_ID"

            arbData={sampleArbData}

            handleReceiveArbData={(arbData: Uint8Array) => {

                let sampleOutputStrData = textDecoder.decode(arbData);

                let sampleOutput = JSON.parse(sampleOutputStrData)

                console.log(sampleOutput.text)

            }}

        />

Simply encode your stringified data (optionally JSON) to Uint8Array and pass it to the arbData prop. Catalyst will send it to each other member in the call, triggering their respective handleReceiveArbData functions. In the example above, that simply triggers a console log, but you can accomplish almost anything.

Accessing Internal User Data

Catalyst offers a handleUserData method to access the internal metadata of a particular user, triggered when their token is generated to join a session.

A JSON object in the following format is passed:

xxxxxxxxxx

interface CatalystUserData {

  token: string;

  roomName: string;

  participantName: string;

  persistedUserResult: {

    meetingJoins: {

      roomName: string;

      joinTime: string;

    }[];

    _id: string;

    appId: string;

    uniqueClientIdentifier: string;

    lastActive: string;

    lastParticipantName: string;

    createdAt: string;

    updatedAt: string;

    __v: number;

  };

  isNewUser: boolean;

}

An example of a component accessing this data is shown below:

xxxxxxxxxx

    <CatalystChat

            room="ROOM_NAME"

            appId="YOUR_CATALYST_PROJECT_ID"

            handleUserData={data => console.log('user data: ', data)}

        />