Class: GoogleDrive::Acl
- Inherits:
-
Object
- Object
- GoogleDrive::Acl
- Extended by:
- Forwardable
- Includes:
- Util
- Defined in:
- lib/google_drive/acl.rb
Overview
ACL (access control list) of a spreadsheet.
Use GoogleDrive::Spreadsheet#acl to get GoogleDrive::Acl object. See GoogleDrive::Spreadsheet#acl for usage example.
This code is based on github.com/guyboertje/gdata-spreadsheet-ruby .
Constant Summary
Constants included from Util
Util::EXT_TO_CONTENT_TYPE, Util::IMPORTABLE_CONTENT_TYPE_MAP
Instance Method Summary collapse
-
#delete(entry) ⇒ Object
Deletes an ACL entry.
-
#initialize(session, file) ⇒ Acl
constructor
:nodoc:.
- #inspect ⇒ Object
-
#push(params_or_entry, options = {}) ⇒ Object
Adds a new entry.
-
#update_role(entry) ⇒ Object
:nodoc:.
Methods included from Util
concat_url, construct_and_query, construct_query, convert_params, delegate_api_methods, encode_query, get_singleton_class, h
Constructor Details
Instance Method Details
#delete(entry) ⇒ Object
Deletes an ACL entry.
e.g.
spreadsheet.acl.delete(spreadsheet.acl[1])
76 77 78 79 |
# File 'lib/google_drive/acl.rb', line 76 def delete(entry) @session.drive.(@file.id, entry.id) @entries.delete(entry) end |
#inspect ⇒ Object
88 89 90 |
# File 'lib/google_drive/acl.rb', line 88 def inspect "\#<%p %p>" % [self.class, @entries] end |
#push(params_or_entry, options = {}) ⇒ Object
Adds a new entry. entry
is either a GoogleDrive::AclEntry or a Hash with keys :type
, :email_address
, :domain
, :role
and :allow_file_discovery
. See GoogleDrive::AclEntry#type and GoogleDrive::AclEntry#role for the document of the fields.
Also you can pass the second hash argument options
, which specifies optional query parameters for the API. Possible keys of options
are,
-
:emailMessage – A custom message to include in notification emails
-
:sendNotificationEmails – Whether to send notification emails when sharing to users or groups.
NOTE: This sends email to the new people.
e.g.
# A specific user can read or write.
spreadsheet.acl.push(
{type: "user", email_address: "[email protected]", role: "reader"})
spreadsheet.acl.push(
{type: "user", email_address: "[email protected]", role: "writer"})
# Share with a Google Apps domain.
spreadsheet.acl.push(
{type: "domain", domain: "gimite.net", role: "reader"})
# Publish on the Web.
spreadsheet.acl.push(
{type: "anyone", role: "reader"})
# Anyone who knows the link can read.
spreadsheet.acl.push(
{type: "anyone", allow_file_discovery: false, role: "reader"})
# Set ACL without sending notification emails
spreadsheet.acl.push(
{type: "user", email_address: "[email protected]", role: "reader"},
{sendNotificationEmails: false})
See here for parameter detais: developers.google.com/drive/v3/reference/permissions/create
64 65 66 67 68 69 70 |
# File 'lib/google_drive/acl.rb', line 64 def push(params_or_entry, = {}) entry = params_or_entry.is_a?(AclEntry) ? params_or_entry : AclEntry.new(params_or_entry) = @session.drive.(@file.id, entry.params, {fields: '*'}.merge()) new_entry = AclEntry.new(, self) @entries.push(new_entry) new_entry end |
#update_role(entry) ⇒ Object
:nodoc:
81 82 83 84 85 86 |
# File 'lib/google_drive/acl.rb', line 81 def update_role(entry) #:nodoc: = @session.drive.( @file.id, entry.id, {role: entry.role}, fields: '*') entry. = entry end |