REST API for services dealing with spaces. v2beta
Package
@google-apps/meetConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of SpacesServiceClient.
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.
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.
conferenceRecord
string
string
{string} Resource name string.
connectActiveConference(request, options)
connectActiveConference
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceResponse
,
(
protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceRequest
|
undefined
),
{}
|
undefined
]>;
[Developer Preview]( https://developers.google.com/workspace/preview ): Broker a WebRTC connection to the active conference of a space.
On success, clients must use the resulting SDP (Session Description Protocol) answer to establish a WebRTC connection. Once connected, additional functionality is available across WebRTC data channels.
See [Meet Media API overview]( https://developers.google.com/meet/media-api/guides/overview ) for more details about this connection.
request
options
Promise
<[ protos.google.apps.meet.v2beta.IConnectActiveConferenceResponse
,
( protos.google.apps.meet.v2beta.IConnectActiveConferenceRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing ConnectActiveConferenceResponse . Please see the documentation for more details and examples.
/**
* 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.
* Format: spaces/{spaceId}
*/
// const name = 'abc123'
/**
* Required. WebRTC SDP (Session Description Protocol) offer from the client.
* The format is defined by RFC
* 8866 (https://www.rfc-editor.org/rfc/rfc8866) with mandatory keys defined
* by RFC 8829 (https://www.rfc-editor.org/rfc/rfc8829). This is the standard
* SDP format generated by a peer connection's createOffer() and
* createAnswer() methods.
*/
// const offer = 'abc123'
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
' @google-apps/meet
'
).
v2beta
;
// Instantiates a client
const
meetClient
=
new
SpacesServiceClient
();
async
function
callConnectActiveConference
()
{
// Construct request
const
request
=
{
name
,
offer
,
};
// Run request
const
response
=
await
meetClient
.
connectActiveConference
(
request
);
console
.
log
(
response
);
}
callConnectActiveConference
();
connectActiveConference(request, options, callback)
connectActiveConference
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceResponse
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.apps.meet.v2beta.IConnectActiveConferenceResponse
, protos.google.apps.meet.v2beta.IConnectActiveConferenceRequest
| null | undefined, {} | null | undefined>
void
connectActiveConference(request, callback)
connectActiveConference
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceRequest
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceResponse
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IConnectActiveConferenceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.apps.meet.v2beta.IConnectActiveConferenceResponse
, protos.google.apps.meet.v2beta.IConnectActiveConferenceRequest
| null | undefined, {} | null | undefined>
void
createMember(request, options)
createMember
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateMemberRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
,
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateMemberRequest
|
undefined
,
{}
|
undefined
]>;
[Developer Preview]( https://developers.google.com/workspace/preview ): Create a member.
This API supports the fields
parameter in [SystemParameterContext]( https://cloud.google.com/apis/docs/system-parameters
). When the fields
parameter is omitted, this API response will default to "name,email,role,user".
request
options
Promise
<[ protos.google.apps.meet.v2beta.IMember
, protos.google.apps.meet.v2beta.ICreateMemberRequest
| 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.
/**
* 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: spaces/{space}
*/
// const parent = 'abc123'
/**
* Required. The member to be created.
*/
// const member = {}
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
' @google-apps/meet
'
).
v2beta
;
// Instantiates a client
const
meetClient
=
new
SpacesServiceClient
();
async
function
callCreateMember
()
{
// Construct request
const
request
=
{
parent
,
member
,
};
// Run request
const
response
=
await
meetClient
.
createMember
(
request
);
console
.
log
(
response
);
}
callCreateMember
();
createMember(request, options, callback)
createMember
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateMemberRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
,
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateMemberRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.apps.meet.v2beta.IMember
, protos.google.apps.meet.v2beta.ICreateMemberRequest
| null | undefined, {} | null | undefined>
void
createMember(request, callback)
createMember
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateMemberRequest
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
,
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateMemberRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.apps.meet.v2beta.IMember
, protos.google.apps.meet.v2beta.ICreateMemberRequest
| null | undefined, {} | null | undefined>
void
createSpace(request, options)
createSpace
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateSpaceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateSpaceRequest
|
undefined
,
{}
|
undefined
]>;
Creates a space.
request
options
Promise
<[ protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.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.
/**
* 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
'
).
v2beta
;
// 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
.
v2beta
.
ICreateSpaceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateSpaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.ICreateSpaceRequest
| null | undefined, {} | null | undefined>
void
createSpace(request, callback)
createSpace
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateSpaceRequest
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
ICreateSpaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.ICreateSpaceRequest
| null | undefined, {} | null | undefined>
void
deleteMember(request, options)
deleteMember
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IDeleteMemberRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IDeleteMemberRequest
|
undefined
,
{}
|
undefined
]>;
[Developer Preview]( https://developers.google.com/workspace/preview ): Delete the member who was previously assigned roles in the space.
request
options
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.apps.meet.v2beta.IDeleteMemberRequest
| 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.
/**
* 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: “spaces/{space}/members/{member}”
*/
// const name = 'abc123'
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
'@
goo
@
google
-
apps
/
meet
2beta ;
// Instantiates a client
const
meetClient
=
new
new
SpacesServiceClient
()
async
function
callDeleteMember
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
meetClient
.
deleteMember
(
request
);
console
.
log
(
response
);
}
callDeleteMember
();
deleteMember(request, options, callback)
deleteMember
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IDeleteMemberRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IDeleteMemberRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.apps.meet.v2beta.IDeleteMemberRequest
| null | undefined, {} | null | undefined>
void
deleteMember(request, callback)
deleteMember
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IDeleteMemberRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IDeleteMemberRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.apps.meet.v2beta.IDeleteMemberRequest
| null | undefined, {} | null | undefined>
void
endActiveConference(request, options)
endActiveConference
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IEndActiveConferenceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IEndActiveConferenceRequest
|
undefined
,
{}
|
undefined
]>;
Ends an active conference (if there's one).
For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
request
options
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.apps.meet.v2beta.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.
/**
* 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.
* Format: `spaces/{space}`.
* `{space}` is the resource identifier for the space. It's a unique,
* server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`.
* For more information, see How Meet identifies a meeting
* space (https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
*/
// const name = 'abc123'
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
' @google-apps/meet
'
).
v2beta
;
// 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
.
v2beta
.
IEndActiveConferenceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IEndActiveConferenceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.apps.meet.v2beta.IEndActiveConferenceRequest
| null | undefined, {} | null | undefined>
void
endActiveConference(request, callback)
endActiveConference
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IEndActiveConferenceRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IEndActiveConferenceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.apps.meet.v2beta.IEndActiveConferenceRequest
| null | undefined, {} | null | undefined>
void
getMember(request, options)
getMember
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetMemberRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetMemberRequest
|
undefined
,
{}
|
undefined
]>;
[Developer Preview]( https://developers.google.com/workspace/preview ): Get a member.
This API supports the fields
parameter in [SystemParameterContext]( https://cloud.google.com/apis/docs/system-parameters
). When the fields
parameter is omitted, this API response will default to "name,email,role,user".
request
options
Promise
<[ protos.google.apps.meet.v2beta.IMember
, protos.google.apps.meet.v2beta.IGetMemberRequest
| 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.
/**
* 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: “spaces/{space}/members/{member}”
*/
// const name = 'abc123'
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
'@
goo
@
google
-
apps
/
meet
2beta ;
// Instantiates a client
const
meetClient
=
new
new
SpacesServiceClient
()
async
function
callGetMember
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
meetClient
.
getMember
(
request
);
console
.
log
(
response
);
}
callGetMember
();
getMember(request, options, callback)
getMember
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetMemberRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetMemberRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.apps.meet.v2beta.IMember
, protos.google.apps.meet.v2beta.IGetMemberRequest
| null | undefined, {} | null | undefined>
void
getMember(request, callback)
getMember
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetMemberRequest
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetMemberRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.apps.meet.v2beta.IMember
, protos.google.apps.meet.v2beta.IGetMemberRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getSpace(request, options)
getSpace
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetSpaceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetSpaceRequest
|
undefined
,
{}
|
undefined
]>;
Gets details about a meeting space.
For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
request
options
Promise
<[ protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.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.
/**
* 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.
* Format: `spaces/{space}` or `spaces/{meetingCode}`.
* `{space}` is the resource identifier for the space. It's a unique,
* server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`.
* `{meetingCode}` is an alias for the space. It's a typeable, unique
* character string and is non-case sensitive. For example, `abc-mnop-xyz`.
* The maximum length is 128 characters.
* A `meetingCode` shouldn't be stored long term as it can become
* dissociated from a meeting space and can be reused for different meeting
* spaces in the future. Generally, a `meetingCode` expires 365 days after
* last use. For more information, see Learn about meeting codes in Google
* Meet (https://support.google.com/meet/answer/10710509).
* For more information, see How Meet identifies a meeting
* space (https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
*/
// const name = 'abc123'
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
' @google-apps/meet
'
).
v2beta
;
// 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
.
v2beta
.
IGetSpaceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetSpaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.IGetSpaceRequest
| null | undefined, {} | null | undefined>
void
getSpace(request, callback)
getSpace
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetSpaceRequest
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IGetSpaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.IGetSpaceRequest
| null | undefined, {} | null | undefined>
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.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listMembers(request, options)
listMembers
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
[],
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
|
null
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersResponse
]>;
[Developer Preview]( https://developers.google.com/workspace/preview ): List members.
This API supports the fields
parameter in [SystemParameterContext]( https://cloud.google.com/apis/docs/system-parameters
). When the fields
parameter is omitted this API response will default to "name,email,role,user".
request
options
Promise
<[ protos.google.apps.meet.v2beta.IMember
[], protos.google.apps.meet.v2beta.IListMembersRequest
| null, protos.google.apps.meet.v2beta.IListMembersResponse
]>
{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 listMembersAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listMembers(request, options, callback)
listMembers
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersResponse
|
null
|
undefined
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.apps.meet.v2beta.IListMembersRequest
, protos.google.apps.meet.v2beta.IListMembersResponse
| null | undefined, protos.google.apps.meet.v2beta.IMember
>
void
listMembers(request, callback)
listMembers
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
,
callback
:
PaginationCallback<protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersResponse
|
null
|
undefined
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
> )
:
void
;
request
callback
PaginationCallback
< protos.google.apps.meet.v2beta.IListMembersRequest
, protos.google.apps.meet.v2beta.IListMembersResponse
| null | undefined, protos.google.apps.meet.v2beta.IMember
>
void
listMembersAsync(request, options)
listMembersAsync
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
apps
.
meet
.
v2beta
.
IMember
> ;
Equivalent to listMembers
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.apps.meet.v2beta.IMember
>
{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.
/**
* 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: spaces/{space}
*/
// const parent = 'abc123'
/**
* Optional. Maximum number of members to return. The service might return
* fewer than this value. If unspecified, at most 25 members 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'
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
' @google-apps/meet
'
).
v2beta
;
// Instantiates a client
const
meetClient
=
new
SpacesServiceClient
();
async
function
callListMembers
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
meetClient
.
listMembersAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListMembers
();
listMembersStream(request, options)
listMembersStream
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IListMembersRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listMembers
, but returns a NodeJS Stream object.
request
options
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 listMembersAsync()
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.
conferenceRecordName
string
A fully-qualified path representing ConferenceRecord resource.
string | number
{string} A string representing the conference_record.
matchConferenceRecordFromParticipantName(participantName)
matchConferenceRecordFromParticipantName
(
participantName
:
string
)
:
string
|
number
;
Parse the conference_record from Participant resource.
participantName
string
A fully-qualified path representing Participant resource.
string | number
{string} A string representing the conference_record.
matchConferenceRecordFromParticipantSessionName(participantSessionName)
matchConferenceRecordFromParticipantSessionName
(
participantSessionName
:
string
)
:
string
|
number
;
Parse the conference_record from ParticipantSession resource.
participantSessionName
string
A fully-qualified path representing ParticipantSession resource.
string | number
{string} A string representing the conference_record.
matchConferenceRecordFromRecordingName(recordingName)
matchConferenceRecordFromRecordingName
(
recordingName
:
string
)
:
string
|
number
;
Parse the conference_record from Recording resource.
recordingName
string
A fully-qualified path representing Recording resource.
string | number
{string} A string representing the conference_record.
matchConferenceRecordFromTranscriptEntryName(transcriptEntryName)
matchConferenceRecordFromTranscriptEntryName
(
transcriptEntryName
:
string
)
:
string
|
number
;
Parse the conference_record from TranscriptEntry resource.
transcriptEntryName
string
A fully-qualified path representing TranscriptEntry resource.
string | number
{string} A string representing the conference_record.
matchConferenceRecordFromTranscriptName(transcriptName)
matchConferenceRecordFromTranscriptName
(
transcriptName
:
string
)
:
string
|
number
;
Parse the conference_record from Transcript resource.
transcriptName
string
A fully-qualified path representing Transcript resource.
string | number
{string} A string representing the conference_record.
matchEntryFromTranscriptEntryName(transcriptEntryName)
matchEntryFromTranscriptEntryName
(
transcriptEntryName
:
string
)
:
string
|
number
;
Parse the entry from TranscriptEntry resource.
transcriptEntryName
string
A fully-qualified path representing TranscriptEntry resource.
string | number
{string} A string representing the entry.
matchMemberFromMemberName(memberName)
matchMemberFromMemberName
(
memberName
:
string
)
:
string
|
number
;
Parse the member from Member resource.
memberName
string
A fully-qualified path representing Member resource.
string | number
{string} A string representing the member.
matchParticipantFromParticipantName(participantName)
matchParticipantFromParticipantName
(
participantName
:
string
)
:
string
|
number
;
Parse the participant from Participant resource.
participantName
string
A fully-qualified path representing Participant resource.
string | number
{string} A string representing the participant.
matchParticipantFromParticipantSessionName(participantSessionName)
matchParticipantFromParticipantSessionName
(
participantSessionName
:
string
)
:
string
|
number
;
Parse the participant from ParticipantSession resource.
participantSessionName
string
A fully-qualified path representing ParticipantSession resource.
string | number
{string} A string representing the participant.
matchParticipantSessionFromParticipantSessionName(participantSessionName)
matchParticipantSessionFromParticipantSessionName
(
participantSessionName
:
string
)
:
string
|
number
;
Parse the participant_session from ParticipantSession resource.
participantSessionName
string
A fully-qualified path representing ParticipantSession resource.
string | number
{string} A string representing the participant_session.
matchRecordingFromRecordingName(recordingName)
matchRecordingFromRecordingName
(
recordingName
:
string
)
:
string
|
number
;
Parse the recording from Recording resource.
recordingName
string
A fully-qualified path representing Recording resource.
string | number
{string} A string representing the recording.
matchSpaceFromMemberName(memberName)
matchSpaceFromMemberName
(
memberName
:
string
)
:
string
|
number
;
Parse the space from Member resource.
memberName
string
A fully-qualified path representing Member resource.
string | number
{string} A string representing the space.
matchSpaceFromSpaceName(spaceName)
matchSpaceFromSpaceName
(
spaceName
:
string
)
:
string
|
number
;
Parse the space from Space resource.
spaceName
string
A fully-qualified path representing Space resource.
string | number
{string} A string representing the space.
matchTranscriptFromTranscriptEntryName(transcriptEntryName)
matchTranscriptFromTranscriptEntryName
(
transcriptEntryName
:
string
)
:
string
|
number
;
Parse the transcript from TranscriptEntry resource.
transcriptEntryName
string
A fully-qualified path representing TranscriptEntry resource.
string | number
{string} A string representing the transcript.
matchTranscriptFromTranscriptName(transcriptName)
matchTranscriptFromTranscriptName
(
transcriptName
:
string
)
:
string
|
number
;
Parse the transcript from Transcript resource.
transcriptName
string
A fully-qualified path representing Transcript resource.
string | number
{string} A string representing the transcript.
memberPath(space, member)
memberPath
(
space
:
string
,
member
:
string
)
:
string
;
Return a fully-qualified member resource name string.
space
string
member
string
string
{string} Resource name string.
participantPath(conferenceRecord, participant)
participantPath
(
conferenceRecord
:
string
,
participant
:
string
)
:
string
;
Return a fully-qualified participant resource name string.
conferenceRecord
string
participant
string
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.
conferenceRecord
string
participant
string
participantSession
string
string
{string} Resource name string.
recordingPath(conferenceRecord, recording)
recordingPath
(
conferenceRecord
:
string
,
recording
:
string
)
:
string
;
Return a fully-qualified recording resource name string.
conferenceRecord
string
recording
string
string
{string} Resource name string.
spacePath(space)
spacePath
(
space
:
string
)
:
string
;
Return a fully-qualified space resource name string.
space
string
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.
conferenceRecord
string
transcript
string
entry
string
string
{string} Resource name string.
transcriptPath(conferenceRecord, transcript)
transcriptPath
(
conferenceRecord
:
string
,
transcript
:
string
)
:
string
;
Return a fully-qualified transcript resource name string.
conferenceRecord
string
transcript
string
string
{string} Resource name string.
updateSpace(request, options)
updateSpace
(
request
?:
protos
.
google
.
apps
.
meet
.
v2beta
.
IUpdateSpaceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IUpdateSpaceRequest
|
undefined
,
{}
|
undefined
]>;
Updates details about a meeting space.
For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).
request
options
Promise
<[ protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.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.
/**
* 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(not set, set with empty paths, or only has ""
* as paths), it defaults to update all fields provided with values in the
* request.
* Using "*" as update_mask will update all fields, including deleting fields
* not set in the request.
*/
// const updateMask = {}
// Imports the Meet library
const
{
SpacesServiceClient
}
=
require
(
' @google-apps/meet
'
).
v2beta
;
// 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
.
v2beta
.
IUpdateSpaceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IUpdateSpaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.IUpdateSpaceRequest
| null | undefined, {} | null | undefined>
void
updateSpace(request, callback)
updateSpace
(
request
:
protos
.
google
.
apps
.
meet
.
v2beta
.
IUpdateSpaceRequest
,
callback
:
Callback<protos
.
google
.
apps
.
meet
.
v2beta
.
ISpace
,
protos
.
google
.
apps
.
meet
.
v2beta
.
IUpdateSpaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.apps.meet.v2beta.ISpace
, protos.google.apps.meet.v2beta.IUpdateSpaceRequest
| null | undefined, {} | null | undefined>
void
