ApplicationMetadata | amazon-chime-sdk-js

ApplicationMetadata contains application metadata such as application name and version. Amazon Chime SDK for JavaScript allows builders to provide application metadata in the meeting session configuration. This field is optional. Amazon Chime uses application metadata to analyze meeting health trends or identify common failures to improve your meeting experience.

Do not pass any Personal Identifiable Information (PII).

import { MeetingSessionConfiguration, ApplicationMetadata } from 'amazon-chime-sdk-js';

const createMeetingResponse = // CreateMeeting API response.
const createAttendeeResponse = // CreateAttendee API response.
const meetingSessionConfiguration = new MeetingSessionConfiguration(
 createMeetingResponse,
 createAttendeeResponse
);

meetingSessionConfiguration.applicationMetadata = ApplicationMetadata.create({
 appName: 'AppName',
 appVersion: '1.0.0'
});

Hierarchy

ApplicationMetadata

Index

Properties

Methods

create

Properties

Readonly appName

appName: string

Readonly appVersion

appVersion: string

Methods

Static create

create(appName: string, appVersion: string): ApplicationMetadata

- Defined in src/applicationmetadata/ApplicationMetadata.ts:43
Parameters
- appName: string
  
  Builder's application name. The app name must satisfy following regular expression: /^[a-zA-Z0-9]+[a-zA-Z0-9_-]*[a-zA-Z0-9]+$/g
- appVersion: string
  
  Builder's application version. The app version must follow the Semantic Versioning format.
Returns ApplicationMetadata

ApplicationMetadata

Hierarchy

Index

Properties

Methods

Properties

Readonly appName

Readonly appVersion

Methods

Static create

Parameters

appName: string

appVersion: string

Returns ApplicationMetadata