[−][src]Struct google_classroom1::UserProfileGuardianInvitationGetCall
Returns a specific guardian invitation.
This method returns the following error codes:
PERMISSION_DENIED
if the requesting user is not permitted to view guardian invitations for the student identified by thestudent_id
, if guardians are not enabled for the domain in question, or for other access errors.INVALID_ARGUMENT
if astudent_id
is specified, but its format cannot be recognized (it is not an email address, nor astudent_id
from the API, nor the literal stringme
).NOT_FOUND
if Classroom cannot find any record of the given student orinvitation_id
. May also be returned if the student exists, but the requesting user does not have access to see that student.
A builder for the guardianInvitations.get method supported by a userProfile resource.
It is not used directly, but through a UserProfileMethods
instance.
Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and // execute the final call using `doit()`. // Values shown here are possibly random and not representative ! let result = hub.user_profiles().guardian_invitations_get("studentId", "invitationId") .doit();
Methods
impl<'a, C, A> UserProfileGuardianInvitationGetCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, GuardianInvitation)>
[src]
Perform the operation you have build so far.
pub fn student_id(
self,
new_value: &str
) -> UserProfileGuardianInvitationGetCall<'a, C, A>
[src]
self,
new_value: &str
) -> UserProfileGuardianInvitationGetCall<'a, C, A>
The ID of the student whose guardian invitation is being requested.
Sets the student id path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
pub fn invitation_id(
self,
new_value: &str
) -> UserProfileGuardianInvitationGetCall<'a, C, A>
[src]
self,
new_value: &str
) -> UserProfileGuardianInvitationGetCall<'a, C, A>
The id
field of the GuardianInvitation
being requested.
Sets the invitation id path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> UserProfileGuardianInvitationGetCall<'a, C, A>
[src]
self,
new_value: &'a mut dyn Delegate
) -> UserProfileGuardianInvitationGetCall<'a, C, A>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
pub fn param<T>(
self,
name: T,
value: T
) -> UserProfileGuardianInvitationGetCall<'a, C, A> where
T: AsRef<str>,
[src]
self,
name: T,
value: T
) -> UserProfileGuardianInvitationGetCall<'a, C, A> where
T: AsRef<str>,
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- access_token (query-string) - OAuth access token.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- quotaUser (query-string) - 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.
- callback (query-string) - JSONP
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- key (query-string) - 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.
- uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
- alt (query-string) - Data format for response.
- $.xgafv (query-string) - V1 error format.
pub fn add_scope<T, S>(
self,
scope: T
) -> UserProfileGuardianInvitationGetCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
self,
scope: T
) -> UserProfileGuardianInvitationGetCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead the default Scope
variant
Scope::GuardianlinkStudentReadonly
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
If None
is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key
parameter (see the param()
function for details).
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
Trait Implementations
impl<'a, C, A> CallBuilder for UserProfileGuardianInvitationGetCall<'a, C, A>
[src]
Auto Trait Implementations
impl<'a, C, A> !Send for UserProfileGuardianInvitationGetCall<'a, C, A>
impl<'a, C, A> Unpin for UserProfileGuardianInvitationGetCall<'a, C, A>
impl<'a, C, A> !Sync for UserProfileGuardianInvitationGetCall<'a, C, A>
impl<'a, C, A> !UnwindSafe for UserProfileGuardianInvitationGetCall<'a, C, A>
impl<'a, C, A> !RefUnwindSafe for UserProfileGuardianInvitationGetCall<'a, C, A>
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Typeable for T where
T: Any,
T: Any,