Struct google_drive3::api::PermissionCreateCall
source · [−]pub struct PermissionCreateCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Creates a permission for a file or shared drive.
A builder for the create method supported by a permission resource.
It is not used directly, but through a PermissionMethods
instance.
Example
Instantiate a resource method builder
use drive3::api::Permission;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Permission::default();
// 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.permissions().create(req, "fileId")
.use_domain_admin_access(false)
.transfer_ownership(true)
.supports_team_drives(false)
.supports_all_drives(true)
.send_notification_email(false)
.move_to_new_owners_root(true)
.enforce_single_parent(false)
.email_message("rebum.")
.doit().await;
Implementations
sourceimpl<'a, S> PermissionCreateCall<'a, S>where
S: Service<Uri> + Clone + Send + Sync + 'static,
S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
impl<'a, S> PermissionCreateCall<'a, S>where
S: Service<Uri> + Clone + Send + Sync + 'static,
S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
sourcepub async fn doit(self) -> Result<(Response<Body>, Permission)>
pub async fn doit(self) -> Result<(Response<Body>, Permission)>
Perform the operation you have build so far.
sourcepub fn request(self, new_value: Permission) -> PermissionCreateCall<'a, S>
pub fn request(self, new_value: Permission) -> PermissionCreateCall<'a, S>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn file_id(self, new_value: &str) -> PermissionCreateCall<'a, S>
pub fn file_id(self, new_value: &str) -> PermissionCreateCall<'a, S>
The ID of the file or shared drive.
Sets the file 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.
sourcepub fn use_domain_admin_access(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
pub fn use_domain_admin_access(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
Sets the use domain admin access query property to the given value.
sourcepub fn transfer_ownership(self, new_value: bool) -> PermissionCreateCall<'a, S>
pub fn transfer_ownership(self, new_value: bool) -> PermissionCreateCall<'a, S>
Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.
Sets the transfer ownership query property to the given value.
sourcepub fn supports_team_drives(self, new_value: bool) -> PermissionCreateCall<'a, S>
pub fn supports_team_drives(self, new_value: bool) -> PermissionCreateCall<'a, S>
Deprecated use supportsAllDrives instead.
Sets the supports team drives query property to the given value.
sourcepub fn supports_all_drives(self, new_value: bool) -> PermissionCreateCall<'a, S>
pub fn supports_all_drives(self, new_value: bool) -> PermissionCreateCall<'a, S>
Whether the requesting application supports both My Drives and shared drives.
Sets the supports all drives query property to the given value.
sourcepub fn send_notification_email(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
pub fn send_notification_email(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
Sets the send notification email query property to the given value.
sourcepub fn move_to_new_owners_root(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
pub fn move_to_new_owners_root(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner’s My Drive root folder and all prior parents removed. If set to false, parents are not changed.
Sets the move to new owners root query property to the given value.
sourcepub fn enforce_single_parent(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
pub fn enforce_single_parent(
self,
new_value: bool
) -> PermissionCreateCall<'a, S>
Deprecated. See moveToNewOwnersRoot for details.
Sets the enforce single parent query property to the given value.
sourcepub fn email_message(self, new_value: &str) -> PermissionCreateCall<'a, S>
pub fn email_message(self, new_value: &str) -> PermissionCreateCall<'a, S>
A plain text custom message to include in the notification email.
Sets the email message query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> PermissionCreateCall<'a, S>
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> PermissionCreateCall<'a, S>
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.
sourcepub fn param<T>(self, name: T, value: T) -> PermissionCreateCall<'a, S>where
T: AsRef<str>,
pub fn param<T>(self, name: T, value: T) -> PermissionCreateCall<'a, S>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
- alt (query-string) - Data format for the response.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- 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.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- userIp (query-string) - Deprecated. Please use quotaUser instead.
sourcepub fn add_scope<T, St>(self, scope: T) -> PermissionCreateCall<'a, S>where
T: Into<Option<St>>,
St: AsRef<str>,
pub fn add_scope<T, St>(self, scope: T) -> PermissionCreateCall<'a, S>where
T: Into<Option<St>>,
St: 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::Full
.
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.