google_api_classroom v0.6.0 GoogleApi.Classroom.V1.Api.Registrations View Source
API calls for all endpoints tagged Registrations
.
Link to this section Summary
Functions
Creates a Registration
, causing Classroom to start sending notifications
from the provided feed
to the destination provided in cloudPubSubTopic
.
Deletes a Registration
, causing Classroom to stop sending notifications
for that Registration
.
Link to this section Functions
classroom_registrations_create(connection, optional_params \\ [], opts \\ [])
View Source
classroom_registrations_create(Tesla.Env.client(), keyword(), keyword()) ::
{:ok, GoogleApi.Classroom.V1.Model.Registration.t()} | {:error, Tesla.Env.t()}
classroom_registrations_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Classroom.V1.Model.Registration.t()} | {:error, Tesla.Env.t()}
Creates a Registration
, causing Classroom to start sending notifications
from the provided feed
to the destination provided in cloudPubSubTopic
.
Returns the created Registration
. Currently, this will be the same as
the argument, but with server-assigned fields such as expiry_time
and
id
filled in.
Note that any value specified for the expiry_time
or id
fields will be
ignored.
While Classroom may validate the cloudPubSubTopic
and return errors on a
best effort basis, it is the caller's responsibility to ensure that it
exists and that Classroom has permission to publish to it.
This method may return the following error codes:
PERMISSION_DENIED
if:- the authenticated user does not have permission to receive notifications from the requested field; or
- the credential provided does not include the appropriate scope for the requested feed.
- another access error is encountered.
INVALID_ARGUMENT
if:- no
cloudPubsubTopic
is specified, or the specifiedcloudPubsubTopic
is not valid; or - no
feed
is specified, or the specifiedfeed
is not valid.
- no
NOT_FOUND
if:- the specified
feed
cannot be located, or the requesting user does not have permission to determine whether or not it exists; or - the specified
cloudPubsubTopic
cannot be located, or Classroom has not been granted permission to publish to it.
- the specified
Parameters
connection
(type:GoogleApi.Classroom.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Classroom.V1.Model.Registration.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Classroom.V1.Model.Registration{}}
on success{:error, info}
on failure
classroom_registrations_delete(connection, registration_id, optional_params \\ [], opts \\ [])
View Source
classroom_registrations_delete(
Tesla.Env.client(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.Classroom.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
classroom_registrations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Classroom.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes a Registration
, causing Classroom to stop sending notifications
for that Registration
.
Parameters
connection
(type:GoogleApi.Classroom.V1.Connection.t
) - Connection to serverregistration_id
(type:String.t
) - Theregistration_id
of theRegistration
to be deleted.optional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Classroom.V1.Model.Empty{}}
on success{:error, info}
on failure