Class v2.ConferenceRecordsServiceClient (0.2.0)

REST API for services dealing with conference records. v2

Package

@google-apps/meet

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of ConferenceRecordsServiceClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ConferenceRecordsServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

conferenceRecordsServiceStub

conferenceRecordsServiceStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

conferenceRecordPath(conferenceRecord)

conferenceRecordPath(conferenceRecord: string): string;

Return a fully-qualified conferenceRecord resource name string.

Parameter
NameDescription
conferenceRecord string
Returns
TypeDescription
string

{string} Resource name string.

getConferenceRecord(request, options)

getConferenceRecord(request?: protos.google.apps.meet.v2.IGetConferenceRecordRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IConferenceRecord,
        protos.google.apps.meet.v2.IGetConferenceRecordRequest | undefined,
        {} | undefined
    ]>;

Gets a conference record by conference ID.

Parameters
NameDescription
request IGetConferenceRecordRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IConferenceRecord, protos.google.apps.meet.v2.IGetConferenceRecordRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ConferenceRecord. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the conference.
   */
  // const name = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callGetConferenceRecord() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await meetClient.getConferenceRecord(request);
    console.log(response);
  }

  callGetConferenceRecord();

getConferenceRecord(request, options, callback)

getConferenceRecord(request: protos.google.apps.meet.v2.IGetConferenceRecordRequest, options: CallOptions, callback: Callback<protos.google.apps.meet.v2.IConferenceRecord, protos.google.apps.meet.v2.IGetConferenceRecordRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetConferenceRecordRequest
options CallOptions
callback Callback<protos.google.apps.meet.v2.IConferenceRecord, protos.google.apps.meet.v2.IGetConferenceRecordRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getConferenceRecord(request, callback)

getConferenceRecord(request: protos.google.apps.meet.v2.IGetConferenceRecordRequest, callback: Callback<protos.google.apps.meet.v2.IConferenceRecord, protos.google.apps.meet.v2.IGetConferenceRecordRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetConferenceRecordRequest
callback Callback<protos.google.apps.meet.v2.IConferenceRecord, protos.google.apps.meet.v2.IGetConferenceRecordRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getParticipant(request, options)

getParticipant(request?: protos.google.apps.meet.v2.IGetParticipantRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IParticipant,
        protos.google.apps.meet.v2.IGetParticipantRequest | undefined,
        {} | undefined
    ]>;

Gets a participant by participant ID.

Parameters
NameDescription
request IGetParticipantRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IParticipant, protos.google.apps.meet.v2.IGetParticipantRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Participant. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the participant.
   */
  // const name = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callGetParticipant() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await meetClient.getParticipant(request);
    console.log(response);
  }

  callGetParticipant();

getParticipant(request, options, callback)

getParticipant(request: protos.google.apps.meet.v2.IGetParticipantRequest, options: CallOptions, callback: Callback<protos.google.apps.meet.v2.IParticipant, protos.google.apps.meet.v2.IGetParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetParticipantRequest
options CallOptions
callback Callback<protos.google.apps.meet.v2.IParticipant, protos.google.apps.meet.v2.IGetParticipantRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getParticipant(request, callback)

getParticipant(request: protos.google.apps.meet.v2.IGetParticipantRequest, callback: Callback<protos.google.apps.meet.v2.IParticipant, protos.google.apps.meet.v2.IGetParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetParticipantRequest
callback Callback<protos.google.apps.meet.v2.IParticipant, protos.google.apps.meet.v2.IGetParticipantRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getParticipantSession(request, options)

getParticipantSession(request?: protos.google.apps.meet.v2.IGetParticipantSessionRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IParticipantSession,
        protos.google.apps.meet.v2.IGetParticipantSessionRequest | undefined,
        {} | undefined
    ]>;

Gets a participant session by participant session ID.

Parameters
NameDescription
request IGetParticipantSessionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IParticipantSession, protos.google.apps.meet.v2.IGetParticipantSessionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ParticipantSession. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the participant.
   */
  // const name = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callGetParticipantSession() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await meetClient.getParticipantSession(request);
    console.log(response);
  }

  callGetParticipantSession();

getParticipantSession(request, options, callback)

getParticipantSession(request: protos.google.apps.meet.v2.IGetParticipantSessionRequest, options: CallOptions, callback: Callback<protos.google.apps.meet.v2.IParticipantSession, protos.google.apps.meet.v2.IGetParticipantSessionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetParticipantSessionRequest
options CallOptions
callback Callback<protos.google.apps.meet.v2.IParticipantSession, protos.google.apps.meet.v2.IGetParticipantSessionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getParticipantSession(request, callback)

getParticipantSession(request: protos.google.apps.meet.v2.IGetParticipantSessionRequest, callback: Callback<protos.google.apps.meet.v2.IParticipantSession, protos.google.apps.meet.v2.IGetParticipantSessionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetParticipantSessionRequest
callback Callback<protos.google.apps.meet.v2.IParticipantSession, protos.google.apps.meet.v2.IGetParticipantSessionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getRecording(request, options)

getRecording(request?: protos.google.apps.meet.v2.IGetRecordingRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IRecording,
        protos.google.apps.meet.v2.IGetRecordingRequest | undefined,
        {} | undefined
    ]>;

Gets a recording by recording ID.

Parameters
NameDescription
request IGetRecordingRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IRecording, protos.google.apps.meet.v2.IGetRecordingRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the recording.
   */
  // const name = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callGetRecording() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await meetClient.getRecording(request);
    console.log(response);
  }

  callGetRecording();

getRecording(request, options, callback)

getRecording(request: protos.google.apps.meet.v2.IGetRecordingRequest, options: CallOptions, callback: Callback<protos.google.apps.meet.v2.IRecording, protos.google.apps.meet.v2.IGetRecordingRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetRecordingRequest
options CallOptions
callback Callback<protos.google.apps.meet.v2.IRecording, protos.google.apps.meet.v2.IGetRecordingRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRecording(request, callback)

getRecording(request: protos.google.apps.meet.v2.IGetRecordingRequest, callback: Callback<protos.google.apps.meet.v2.IRecording, protos.google.apps.meet.v2.IGetRecordingRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetRecordingRequest
callback Callback<protos.google.apps.meet.v2.IRecording, protos.google.apps.meet.v2.IGetRecordingRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTranscript(request, options)

getTranscript(request?: protos.google.apps.meet.v2.IGetTranscriptRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.ITranscript,
        protos.google.apps.meet.v2.IGetTranscriptRequest | undefined,
        {} | undefined
    ]>;

Gets a transcript by transcript ID.

Parameters
NameDescription
request IGetTranscriptRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.ITranscript, protos.google.apps.meet.v2.IGetTranscriptRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the transcript.
   */
  // const name = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callGetTranscript() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await meetClient.getTranscript(request);
    console.log(response);
  }

  callGetTranscript();

getTranscript(request, options, callback)

getTranscript(request: protos.google.apps.meet.v2.IGetTranscriptRequest, options: CallOptions, callback: Callback<protos.google.apps.meet.v2.ITranscript, protos.google.apps.meet.v2.IGetTranscriptRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetTranscriptRequest
options CallOptions
callback Callback<protos.google.apps.meet.v2.ITranscript, protos.google.apps.meet.v2.IGetTranscriptRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTranscript(request, callback)

getTranscript(request: protos.google.apps.meet.v2.IGetTranscriptRequest, callback: Callback<protos.google.apps.meet.v2.ITranscript, protos.google.apps.meet.v2.IGetTranscriptRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetTranscriptRequest
callback Callback<protos.google.apps.meet.v2.ITranscript, protos.google.apps.meet.v2.IGetTranscriptRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTranscriptEntry(request, options)

getTranscriptEntry(request?: protos.google.apps.meet.v2.IGetTranscriptEntryRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.ITranscriptEntry,
        protos.google.apps.meet.v2.IGetTranscriptEntryRequest | undefined,
        {} | undefined
    ]>;

Gets a TranscriptEntry resource by entry ID.

Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.

Parameters
NameDescription
request IGetTranscriptEntryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.ITranscriptEntry, protos.google.apps.meet.v2.IGetTranscriptEntryRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing TranscriptEntry. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the `TranscriptEntry`.
   */
  // const name = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callGetTranscriptEntry() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await meetClient.getTranscriptEntry(request);
    console.log(response);
  }

  callGetTranscriptEntry();

getTranscriptEntry(request, options, callback)

getTranscriptEntry(request: protos.google.apps.meet.v2.IGetTranscriptEntryRequest, options: CallOptions, callback: Callback<protos.google.apps.meet.v2.ITranscriptEntry, protos.google.apps.meet.v2.IGetTranscriptEntryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetTranscriptEntryRequest
options CallOptions
callback Callback<protos.google.apps.meet.v2.ITranscriptEntry, protos.google.apps.meet.v2.IGetTranscriptEntryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTranscriptEntry(request, callback)

getTranscriptEntry(request: protos.google.apps.meet.v2.IGetTranscriptEntryRequest, callback: Callback<protos.google.apps.meet.v2.ITranscriptEntry, protos.google.apps.meet.v2.IGetTranscriptEntryRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetTranscriptEntryRequest
callback Callback<protos.google.apps.meet.v2.ITranscriptEntry, protos.google.apps.meet.v2.IGetTranscriptEntryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listConferenceRecords(request, options)

listConferenceRecords(request?: protos.google.apps.meet.v2.IListConferenceRecordsRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IConferenceRecord[],
        protos.google.apps.meet.v2.IListConferenceRecordsRequest | null,
        protos.google.apps.meet.v2.IListConferenceRecordsResponse
    ]>;

Lists the conference records. By default, ordered by start time and in descending order.

Parameters
NameDescription
request IListConferenceRecordsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IConferenceRecord[], protos.google.apps.meet.v2.IListConferenceRecordsRequest | null, protos.google.apps.meet.v2.IListConferenceRecordsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ConferenceRecord. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listConferenceRecordsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listConferenceRecords(request, options, callback)

listConferenceRecords(request: protos.google.apps.meet.v2.IListConferenceRecordsRequest, options: CallOptions, callback: PaginationCallback<protos.google.apps.meet.v2.IListConferenceRecordsRequest, protos.google.apps.meet.v2.IListConferenceRecordsResponse | null | undefined, protos.google.apps.meet.v2.IConferenceRecord>): void;
Parameters
NameDescription
request IListConferenceRecordsRequest
options CallOptions
callback PaginationCallback<protos.google.apps.meet.v2.IListConferenceRecordsRequest, protos.google.apps.meet.v2.IListConferenceRecordsResponse | null | undefined, protos.google.apps.meet.v2.IConferenceRecord>
Returns
TypeDescription
void

listConferenceRecords(request, callback)

listConferenceRecords(request: protos.google.apps.meet.v2.IListConferenceRecordsRequest, callback: PaginationCallback<protos.google.apps.meet.v2.IListConferenceRecordsRequest, protos.google.apps.meet.v2.IListConferenceRecordsResponse | null | undefined, protos.google.apps.meet.v2.IConferenceRecord>): void;
Parameters
NameDescription
request IListConferenceRecordsRequest
callback PaginationCallback<protos.google.apps.meet.v2.IListConferenceRecordsRequest, protos.google.apps.meet.v2.IListConferenceRecordsResponse | null | undefined, protos.google.apps.meet.v2.IConferenceRecord>
Returns
TypeDescription
void

listConferenceRecordsAsync(request, options)

listConferenceRecordsAsync(request?: protos.google.apps.meet.v2.IListConferenceRecordsRequest, options?: CallOptions): AsyncIterable<protos.google.apps.meet.v2.IConferenceRecord>;

Equivalent to listConferenceRecords, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListConferenceRecordsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.apps.meet.v2.IConferenceRecord>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ConferenceRecord. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Maximum number of conference records to return. The service might
   *  return fewer than this value. If unspecified, at most 25 conference records
   *  are returned. The maximum value is 100; values above 100 are coerced to
   *  100. Maximum might change in the future.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token returned from previous List Call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. User specified filtering condition in EBNF
   *  format (https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form).
   *  The following are the filterable fields:
   *  * `space.meeting_code`
   *  * `space.name`
   *  * `start_time`
   *  * `end_time`
   *  For example, `space.meeting_code = "abc-mnop-xyz"`.
   */
  // const filter = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callListConferenceRecords() {
    // Construct request
    const request = {};

    // Run request
    const iterable = meetClient.listConferenceRecordsAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListConferenceRecords();

listConferenceRecordsStream(request, options)

listConferenceRecordsStream(request?: protos.google.apps.meet.v2.IListConferenceRecordsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListConferenceRecordsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing ConferenceRecord on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listConferenceRecordsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listParticipants(request, options)

listParticipants(request?: protos.google.apps.meet.v2.IListParticipantsRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IParticipant[],
        protos.google.apps.meet.v2.IListParticipantsRequest | null,
        protos.google.apps.meet.v2.IListParticipantsResponse
    ]>;

Lists the participants in a conference record. By default, ordered by join time and in descending order. This API supports fields as standard parameters like every other API. However, when the fields request parameter is omitted, this API defaults to 'participants/*, next_page_token'.

Parameters
NameDescription
request IListParticipantsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IParticipant[], protos.google.apps.meet.v2.IListParticipantsRequest | null, protos.google.apps.meet.v2.IListParticipantsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Participant. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listParticipantsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listParticipants(request, options, callback)

listParticipants(request: protos.google.apps.meet.v2.IListParticipantsRequest, options: CallOptions, callback: PaginationCallback<protos.google.apps.meet.v2.IListParticipantsRequest, protos.google.apps.meet.v2.IListParticipantsResponse | null | undefined, protos.google.apps.meet.v2.IParticipant>): void;
Parameters
NameDescription
request IListParticipantsRequest
options CallOptions
callback PaginationCallback<protos.google.apps.meet.v2.IListParticipantsRequest, protos.google.apps.meet.v2.IListParticipantsResponse | null | undefined, protos.google.apps.meet.v2.IParticipant>
Returns
TypeDescription
void

listParticipants(request, callback)

listParticipants(request: protos.google.apps.meet.v2.IListParticipantsRequest, callback: PaginationCallback<protos.google.apps.meet.v2.IListParticipantsRequest, protos.google.apps.meet.v2.IListParticipantsResponse | null | undefined, protos.google.apps.meet.v2.IParticipant>): void;
Parameters
NameDescription
request IListParticipantsRequest
callback PaginationCallback<protos.google.apps.meet.v2.IListParticipantsRequest, protos.google.apps.meet.v2.IListParticipantsResponse | null | undefined, protos.google.apps.meet.v2.IParticipant>
Returns
TypeDescription
void

listParticipantsAsync(request, options)

listParticipantsAsync(request?: protos.google.apps.meet.v2.IListParticipantsRequest, options?: CallOptions): AsyncIterable<protos.google.apps.meet.v2.IParticipant>;

Equivalent to listParticipants, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListParticipantsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.apps.meet.v2.IParticipant>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Participant. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format: `conferenceRecords/{conference_record}`
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of participants to return. The service might return fewer
   *  than this value.
   *  If unspecified, at most 100 participants are returned.
   *  The maximum value is 250; values above 250 are coerced to 250.
   *  Maximum might change in the future.
   */
  // const pageSize = 1234
  /**
   *  Page token returned from previous List Call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. User specified filtering condition in EBNF
   *  format (https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form).
   *  The following are the filterable fields:
   *  * `earliest_start_time`
   *  * `latest_end_time`
   *  For example, `latest_end_time IS NULL` returns active participants in
   *  the conference.
   */
  // const filter = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callListParticipants() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = meetClient.listParticipantsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListParticipants();

listParticipantSessions(request, options)

listParticipantSessions(request?: protos.google.apps.meet.v2.IListParticipantSessionsRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IParticipantSession[],
        protos.google.apps.meet.v2.IListParticipantSessionsRequest | null,
        protos.google.apps.meet.v2.IListParticipantSessionsResponse
    ]>;

Lists the participant sessions of a participant in a conference record. By default, ordered by join time and in descending order. This API supports fields as standard parameters like every other API. However, when the fields request parameter is omitted this API defaults to 'participantsessions/*, next_page_token'.

Parameters
NameDescription
request IListParticipantSessionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IParticipantSession[], protos.google.apps.meet.v2.IListParticipantSessionsRequest | null, protos.google.apps.meet.v2.IListParticipantSessionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ParticipantSession. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listParticipantSessionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listParticipantSessions(request, options, callback)

listParticipantSessions(request: protos.google.apps.meet.v2.IListParticipantSessionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.apps.meet.v2.IListParticipantSessionsRequest, protos.google.apps.meet.v2.IListParticipantSessionsResponse | null | undefined, protos.google.apps.meet.v2.IParticipantSession>): void;
Parameters
NameDescription
request IListParticipantSessionsRequest
options CallOptions
callback PaginationCallback<protos.google.apps.meet.v2.IListParticipantSessionsRequest, protos.google.apps.meet.v2.IListParticipantSessionsResponse | null | undefined, protos.google.apps.meet.v2.IParticipantSession>
Returns
TypeDescription
void

listParticipantSessions(request, callback)

listParticipantSessions(request: protos.google.apps.meet.v2.IListParticipantSessionsRequest, callback: PaginationCallback<protos.google.apps.meet.v2.IListParticipantSessionsRequest, protos.google.apps.meet.v2.IListParticipantSessionsResponse | null | undefined, protos.google.apps.meet.v2.IParticipantSession>): void;
Parameters
NameDescription
request IListParticipantSessionsRequest
callback PaginationCallback<protos.google.apps.meet.v2.IListParticipantSessionsRequest, protos.google.apps.meet.v2.IListParticipantSessionsResponse | null | undefined, protos.google.apps.meet.v2.IParticipantSession>
Returns
TypeDescription
void

listParticipantSessionsAsync(request, options)

listParticipantSessionsAsync(request?: protos.google.apps.meet.v2.IListParticipantSessionsRequest, options?: CallOptions): AsyncIterable<protos.google.apps.meet.v2.IParticipantSession>;

Equivalent to listParticipantSessions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListParticipantSessionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.apps.meet.v2.IParticipantSession>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ParticipantSession. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `conferenceRecords/{conference_record}/participants/{participant}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of participant sessions to return. The service
   *  might return fewer than this value. If unspecified, at most 100
   *  participants are returned. The maximum value is 250; values above 250 are
   *  coerced to 250. Maximum might change in the future.
   */
  // const pageSize = 1234
  /**
   *  Optional. Page token returned from previous List Call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. User specified filtering condition in EBNF
   *  format (https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form).
   *  The following are the filterable fields:
   *  * `start_time`
   *  * `end_time`
   *  For example, `end_time IS NULL` returns active participant sessions in
   *  the conference record.
   */
  // const filter = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callListParticipantSessions() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = meetClient.listParticipantSessionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListParticipantSessions();

listParticipantSessionsStream(request, options)

listParticipantSessionsStream(request?: protos.google.apps.meet.v2.IListParticipantSessionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListParticipantSessionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing ParticipantSession on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listParticipantSessionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listParticipantsStream(request, options)

listParticipantsStream(request?: protos.google.apps.meet.v2.IListParticipantsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListParticipantsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing Participant on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listParticipantsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRecordings(request, options)

listRecordings(request?: protos.google.apps.meet.v2.IListRecordingsRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.IRecording[],
        protos.google.apps.meet.v2.IListRecordingsRequest | null,
        protos.google.apps.meet.v2.IListRecordingsResponse
    ]>;

Lists the recording resources from the conference record. By default, ordered by start time and in ascending order.

Parameters
NameDescription
request IListRecordingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.IRecording[], protos.google.apps.meet.v2.IListRecordingsRequest | null, protos.google.apps.meet.v2.IListRecordingsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listRecordingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRecordings(request, options, callback)

listRecordings(request: protos.google.apps.meet.v2.IListRecordingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.apps.meet.v2.IListRecordingsRequest, protos.google.apps.meet.v2.IListRecordingsResponse | null | undefined, protos.google.apps.meet.v2.IRecording>): void;
Parameters
NameDescription
request IListRecordingsRequest
options CallOptions
callback PaginationCallback<protos.google.apps.meet.v2.IListRecordingsRequest, protos.google.apps.meet.v2.IListRecordingsResponse | null | undefined, protos.google.apps.meet.v2.IRecording>
Returns
TypeDescription
void

listRecordings(request, callback)

listRecordings(request: protos.google.apps.meet.v2.IListRecordingsRequest, callback: PaginationCallback<protos.google.apps.meet.v2.IListRecordingsRequest, protos.google.apps.meet.v2.IListRecordingsResponse | null | undefined, protos.google.apps.meet.v2.IRecording>): void;
Parameters
NameDescription
request IListRecordingsRequest
callback PaginationCallback<protos.google.apps.meet.v2.IListRecordingsRequest, protos.google.apps.meet.v2.IListRecordingsResponse | null | undefined, protos.google.apps.meet.v2.IRecording>
Returns
TypeDescription
void

listRecordingsAsync(request, options)

listRecordingsAsync(request?: protos.google.apps.meet.v2.IListRecordingsRequest, options?: CallOptions): AsyncIterable<protos.google.apps.meet.v2.IRecording>;

Equivalent to listRecordings, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListRecordingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.apps.meet.v2.IRecording>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format: `conferenceRecords/{conference_record}`
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of recordings to return. The service might return fewer
   *  than this value.
   *  If unspecified, at most 10 recordings are returned.
   *  The maximum value is 100; values above 100 are coerced to 100.
   *  Maximum might change in the future.
   */
  // const pageSize = 1234
  /**
   *  Page token returned from previous List Call.
   */
  // const pageToken = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callListRecordings() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = meetClient.listRecordingsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRecordings();

listRecordingsStream(request, options)

listRecordingsStream(request?: protos.google.apps.meet.v2.IListRecordingsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListRecordingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRecordingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTranscriptEntries(request, options)

listTranscriptEntries(request?: protos.google.apps.meet.v2.IListTranscriptEntriesRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.ITranscriptEntry[],
        protos.google.apps.meet.v2.IListTranscriptEntriesRequest | null,
        protos.google.apps.meet.v2.IListTranscriptEntriesResponse
    ]>;

Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order.

Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.

Parameters
NameDescription
request IListTranscriptEntriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.ITranscriptEntry[], protos.google.apps.meet.v2.IListTranscriptEntriesRequest | null, protos.google.apps.meet.v2.IListTranscriptEntriesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of TranscriptEntry. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTranscriptEntriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTranscriptEntries(request, options, callback)

listTranscriptEntries(request: protos.google.apps.meet.v2.IListTranscriptEntriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.apps.meet.v2.IListTranscriptEntriesRequest, protos.google.apps.meet.v2.IListTranscriptEntriesResponse | null | undefined, protos.google.apps.meet.v2.ITranscriptEntry>): void;
Parameters
NameDescription
request IListTranscriptEntriesRequest
options CallOptions
callback PaginationCallback<protos.google.apps.meet.v2.IListTranscriptEntriesRequest, protos.google.apps.meet.v2.IListTranscriptEntriesResponse | null | undefined, protos.google.apps.meet.v2.ITranscriptEntry>
Returns
TypeDescription
void

listTranscriptEntries(request, callback)

listTranscriptEntries(request: protos.google.apps.meet.v2.IListTranscriptEntriesRequest, callback: PaginationCallback<protos.google.apps.meet.v2.IListTranscriptEntriesRequest, protos.google.apps.meet.v2.IListTranscriptEntriesResponse | null | undefined, protos.google.apps.meet.v2.ITranscriptEntry>): void;
Parameters
NameDescription
request IListTranscriptEntriesRequest
callback PaginationCallback<protos.google.apps.meet.v2.IListTranscriptEntriesRequest, protos.google.apps.meet.v2.IListTranscriptEntriesResponse | null | undefined, protos.google.apps.meet.v2.ITranscriptEntry>
Returns
TypeDescription
void

listTranscriptEntriesAsync(request, options)

listTranscriptEntriesAsync(request?: protos.google.apps.meet.v2.IListTranscriptEntriesRequest, options?: CallOptions): AsyncIterable<protos.google.apps.meet.v2.ITranscriptEntry>;

Equivalent to listTranscriptEntries, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListTranscriptEntriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.apps.meet.v2.ITranscriptEntry>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing TranscriptEntry. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `conferenceRecords/{conference_record}/transcripts/{transcript}`
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of entries to return. The service might return fewer than
   *  this value.
   *  If unspecified, at most 10 entries are returned.
   *  The maximum value is 100; values above 100 are coerced to 100.
   *  Maximum might change in the future.
   */
  // const pageSize = 1234
  /**
   *  Page token returned from previous List Call.
   */
  // const pageToken = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callListTranscriptEntries() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = meetClient.listTranscriptEntriesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTranscriptEntries();

listTranscriptEntriesStream(request, options)

listTranscriptEntriesStream(request?: protos.google.apps.meet.v2.IListTranscriptEntriesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListTranscriptEntriesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing TranscriptEntry on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTranscriptEntriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTranscripts(request, options)

listTranscripts(request?: protos.google.apps.meet.v2.IListTranscriptsRequest, options?: CallOptions): Promise<[
        protos.google.apps.meet.v2.ITranscript[],
        protos.google.apps.meet.v2.IListTranscriptsRequest | null,
        protos.google.apps.meet.v2.IListTranscriptsResponse
    ]>;

Lists the set of transcripts from the conference record. By default, ordered by start time and in ascending order.

Parameters
NameDescription
request IListTranscriptsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.apps.meet.v2.ITranscript[], protos.google.apps.meet.v2.IListTranscriptsRequest | null, protos.google.apps.meet.v2.IListTranscriptsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTranscriptsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTranscripts(request, options, callback)

listTranscripts(request: protos.google.apps.meet.v2.IListTranscriptsRequest, options: CallOptions, callback: PaginationCallback<protos.google.apps.meet.v2.IListTranscriptsRequest, protos.google.apps.meet.v2.IListTranscriptsResponse | null | undefined, protos.google.apps.meet.v2.ITranscript>): void;
Parameters
NameDescription
request IListTranscriptsRequest
options CallOptions
callback PaginationCallback<protos.google.apps.meet.v2.IListTranscriptsRequest, protos.google.apps.meet.v2.IListTranscriptsResponse | null | undefined, protos.google.apps.meet.v2.ITranscript>
Returns
TypeDescription
void

listTranscripts(request, callback)

listTranscripts(request: protos.google.apps.meet.v2.IListTranscriptsRequest, callback: PaginationCallback<protos.google.apps.meet.v2.IListTranscriptsRequest, protos.google.apps.meet.v2.IListTranscriptsResponse | null | undefined, protos.google.apps.meet.v2.ITranscript>): void;
Parameters
NameDescription
request IListTranscriptsRequest
callback PaginationCallback<protos.google.apps.meet.v2.IListTranscriptsRequest, protos.google.apps.meet.v2.IListTranscriptsResponse | null | undefined, protos.google.apps.meet.v2.ITranscript>
Returns
TypeDescription
void

listTranscriptsAsync(request, options)

listTranscriptsAsync(request?: protos.google.apps.meet.v2.IListTranscriptsRequest, options?: CallOptions): AsyncIterable<protos.google.apps.meet.v2.ITranscript>;

Equivalent to listTranscripts, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListTranscriptsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.apps.meet.v2.ITranscript>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format: `conferenceRecords/{conference_record}`
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of transcripts to return. The service might return fewer
   *  than this value.
   *  If unspecified, at most 10 transcripts are returned.
   *  The maximum value is 100; values above 100 are coerced to 100.
   *  Maximum might change in the future.
   */
  // const pageSize = 1234
  /**
   *  Page token returned from previous List Call.
   */
  // const pageToken = 'abc123'

  // Imports the Meet library
  const {ConferenceRecordsServiceClient} = require('@google-apps/meet').v2;

  // Instantiates a client
  const meetClient = new ConferenceRecordsServiceClient();

  async function callListTranscripts() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = meetClient.listTranscriptsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTranscripts();

listTranscriptsStream(request, options)

listTranscriptsStream(request?: protos.google.apps.meet.v2.IListTranscriptsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListTranscriptsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTranscriptsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchConferenceRecordFromConferenceRecordName(conferenceRecordName)

matchConferenceRecordFromConferenceRecordName(conferenceRecordName: string): string | number;

Parse the conference_record from ConferenceRecord resource.

Parameter
NameDescription
conferenceRecordName string

A fully-qualified path representing ConferenceRecord resource.

Returns
TypeDescription
string | number

{string} A string representing the conference_record.

matchConferenceRecordFromParticipantName(participantName)

matchConferenceRecordFromParticipantName(participantName: string): string | number;

Parse the conference_record from Participant resource.

Parameter
NameDescription
participantName string

A fully-qualified path representing Participant resource.

Returns
TypeDescription
string | number

{string} A string representing the conference_record.

matchConferenceRecordFromParticipantSessionName(participantSessionName)

matchConferenceRecordFromParticipantSessionName(participantSessionName: string): string | number;

Parse the conference_record from ParticipantSession resource.

Parameter
NameDescription
participantSessionName string

A fully-qualified path representing ParticipantSession resource.

Returns
TypeDescription
string | number

{string} A string representing the conference_record.

matchConferenceRecordFromRecordingName(recordingName)

matchConferenceRecordFromRecordingName(recordingName: string): string | number;

Parse the conference_record from Recording resource.

Parameter
NameDescription
recordingName string

A fully-qualified path representing Recording resource.

Returns
TypeDescription
string | number

{string} A string representing the conference_record.

matchConferenceRecordFromTranscriptEntryName(transcriptEntryName)

matchConferenceRecordFromTranscriptEntryName(transcriptEntryName: string): string | number;

Parse the conference_record from TranscriptEntry resource.

Parameter
NameDescription
transcriptEntryName string

A fully-qualified path representing TranscriptEntry resource.

Returns
TypeDescription
string | number

{string} A string representing the conference_record.

matchConferenceRecordFromTranscriptName(transcriptName)

matchConferenceRecordFromTranscriptName(transcriptName: string): string | number;

Parse the conference_record from Transcript resource.

Parameter
NameDescription
transcriptName string

A fully-qualified path representing Transcript resource.

Returns
TypeDescription
string | number

{string} A string representing the conference_record.

matchEntryFromTranscriptEntryName(transcriptEntryName)

matchEntryFromTranscriptEntryName(transcriptEntryName: string): string | number;

Parse the entry from TranscriptEntry resource.

Parameter
NameDescription
transcriptEntryName string

A fully-qualified path representing TranscriptEntry resource.

Returns
TypeDescription
string | number

{string} A string representing the entry.

matchParticipantFromParticipantName(participantName)

matchParticipantFromParticipantName(participantName: string): string | number;

Parse the participant from Participant resource.

Parameter
NameDescription
participantName string

A fully-qualified path representing Participant resource.

Returns
TypeDescription
string | number

{string} A string representing the participant.

matchParticipantFromParticipantSessionName(participantSessionName)

matchParticipantFromParticipantSessionName(participantSessionName: string): string | number;

Parse the participant from ParticipantSession resource.

Parameter
NameDescription
participantSessionName string

A fully-qualified path representing ParticipantSession resource.

Returns
TypeDescription
string | number

{string} A string representing the participant.

matchParticipantSessionFromParticipantSessionName(participantSessionName)

matchParticipantSessionFromParticipantSessionName(participantSessionName: string): string | number;

Parse the participant_session from ParticipantSession resource.

Parameter
NameDescription
participantSessionName string

A fully-qualified path representing ParticipantSession resource.

Returns
TypeDescription
string | number

{string} A string representing the participant_session.

matchRecordingFromRecordingName(recordingName)

matchRecordingFromRecordingName(recordingName: string): string | number;

Parse the recording from Recording resource.

Parameter
NameDescription
recordingName string

A fully-qualified path representing Recording resource.

Returns
TypeDescription
string | number

{string} A string representing the recording.

matchSpaceFromSpaceName(spaceName)

matchSpaceFromSpaceName(spaceName: string): string | number;

Parse the space from Space resource.

Parameter
NameDescription
spaceName string

A fully-qualified path representing Space resource.

Returns
TypeDescription
string | number

{string} A string representing the space.

matchTranscriptFromTranscriptEntryName(transcriptEntryName)

matchTranscriptFromTranscriptEntryName(transcriptEntryName: string): string | number;

Parse the transcript from TranscriptEntry resource.

Parameter
NameDescription
transcriptEntryName string

A fully-qualified path representing TranscriptEntry resource.

Returns
TypeDescription
string | number

{string} A string representing the transcript.

matchTranscriptFromTranscriptName(transcriptName)

matchTranscriptFromTranscriptName(transcriptName: string): string | number;

Parse the transcript from Transcript resource.

Parameter
NameDescription
transcriptName string

A fully-qualified path representing Transcript resource.

Returns
TypeDescription
string | number

{string} A string representing the transcript.

participantPath(conferenceRecord, participant)

participantPath(conferenceRecord: string, participant: string): string;

Return a fully-qualified participant resource name string.

Parameters
NameDescription
conferenceRecord string
participant string
Returns
TypeDescription
string

{string} Resource name string.

participantSessionPath(conferenceRecord, participant, participantSession)

participantSessionPath(conferenceRecord: string, participant: string, participantSession: string): string;

Return a fully-qualified participantSession resource name string.

Parameters
NameDescription
conferenceRecord string
participant string
participantSession string
Returns
TypeDescription
string

{string} Resource name string.

recordingPath(conferenceRecord, recording)

recordingPath(conferenceRecord: string, recording: string): string;

Return a fully-qualified recording resource name string.

Parameters
NameDescription
conferenceRecord string
recording string
Returns
TypeDescription
string

{string} Resource name string.

spacePath(space)

spacePath(space: string): string;

Return a fully-qualified space resource name string.

Parameter
NameDescription
space string
Returns
TypeDescription
string

{string} Resource name string.

transcriptEntryPath(conferenceRecord, transcript, entry)

transcriptEntryPath(conferenceRecord: string, transcript: string, entry: string): string;

Return a fully-qualified transcriptEntry resource name string.

Parameters
NameDescription
conferenceRecord string
transcript string
entry string
Returns
TypeDescription
string

{string} Resource name string.

transcriptPath(conferenceRecord, transcript)

transcriptPath(conferenceRecord: string, transcript: string): string;

Return a fully-qualified transcript resource name string.

Parameters
NameDescription
conferenceRecord string
transcript string
Returns
TypeDescription
string

{string} Resource name string.