Class v2.SpacesServiceClient (0.2.0)

REST API for services dealing with spaces. v2

Package

@google-apps/meet

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of SpacesServiceClient.

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 SpacesServiceClient({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;

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.

spacesServiceStub

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

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.

createSpace(request, options)

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

Creates a space.

Parameters
NameDescription
request ICreateSpaceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Space. 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.
   */
  /**
   *  Space to be created. As of May 2023, the input space can be empty. Later on
   *  the input space can be non-empty when space configuration is introduced.
   */
  // const space = {}

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

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

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

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

  callCreateSpace();

createSpace(request, options, callback)

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

createSpace(request, callback)

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

endActiveConference(request, options)

endActiveConference(request?: protos.google.apps.meet.v2.IEndActiveConferenceRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.apps.meet.v2.IEndActiveConferenceRequest | undefined,
        {} | undefined
    ]>;

Ends an active conference (if there's one).

Parameters
NameDescription
request IEndActiveConferenceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.apps.meet.v2.IEndActiveConferenceRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 space.
   */
  // const name = 'abc123'

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

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

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

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

  callEndActiveConference();

endActiveConference(request, options, callback)

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

endActiveConference(request, callback)

endActiveConference(request: protos.google.apps.meet.v2.IEndActiveConferenceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.apps.meet.v2.IEndActiveConferenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IEndActiveConferenceRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.apps.meet.v2.IEndActiveConferenceRequest | 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

getSpace(request, options)

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

Gets a space by space_id or meeting_code.

Parameters
NameDescription
request IGetSpaceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Space. 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 space.
   */
  // const name = 'abc123'

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

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

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

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

  callGetSpace();

getSpace(request, options, callback)

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

getSpace(request, callback)

getSpace(request: protos.google.apps.meet.v2.IGetSpaceRequest, callback: Callback<protos.google.apps.meet.v2.ISpace, protos.google.apps.meet.v2.IGetSpaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetSpaceRequest
callback Callback<protos.google.apps.meet.v2.ISpace, protos.google.apps.meet.v2.IGetSpaceRequest | 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.

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.

updateSpace(request, options)

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

Updates a space.

Parameters
NameDescription
request IUpdateSpaceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Space. 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. Space to be updated.
   */
  // const space = {}
  /**
   *  Optional. Field mask used to specify the fields to be updated in the space.
   *  If update_mask isn't provided, it defaults to '*' and updates all
   *  fields provided in the request, including deleting fields not set in the
   *  request.
   */
  // const updateMask = {}

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

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

  async function callUpdateSpace() {
    // Construct request
    const request = {
      space,
    };

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

  callUpdateSpace();

updateSpace(request, options, callback)

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

updateSpace(request, callback)

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