class
GoogleDrive::DriveBackgroundImageFile
- GoogleDrive::DriveBackgroundImageFile
- Reference
- Object
Overview
An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
google_drive/models/drive_background_image_file.crConstructors
- .new(pull : JSON::PullParser)
-
.new(*, id : String | Nil = nil, width : Float32 | Nil = nil, x_coordinate : Float32 | Nil = nil, y_coordinate : Float32 | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Summary
-
#==(other : self)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
-
#hash(hasher)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
-
#id : String | Nil
The ID of an image file in Google Drive to use for the background image.
-
#id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
-
#width : Float32 | Nil
The width of the cropped image in the closed range of 0 to 1.
-
#width=(new_value : Float32 | Nil)
Custom attribute writer method checking allowed values (enum).
-
#x_coordinate : Float32 | Nil
The X coordinate of the upper left corner of the cropping area in the background image.
-
#x_coordinate=(new_value : Float32 | Nil)
Custom attribute writer method checking allowed values (enum).
-
#y_coordinate : Float32 | Nil
The Y coordinate of the upper left corner of the cropping area in the background image.
-
#y_coordinate=(new_value : Float32 | Nil)
Custom attribute writer method checking allowed values (enum).
Instance methods inherited from module OpenApi::Json
after_initialize
after_initialize,
clone
clone,
eql?(o : self)
eql?,
to_hash : Hash(String, JSON::Any)
to_hash,
to_json_any : JSON::Any
to_json_any
Class methods inherited from module OpenApi::Json
build_from_hash(hash : Hash)
build_from_hash,
build_from_json_any(json_any : JSON::Any)
build_from_json_any
Instance methods inherited from module OpenApi::Validatable
list_invalid_properties : Array(String)
list_invalid_properties,
list_invalid_properties_for(key : String) : Array(String)
list_invalid_properties_for,
valid? : Bool
valid?,
validate : Nil
validate
Instance methods inherited from module JSON::Serializable
to_hash : JSON::Any
to_hash
Class methods inherited from module JSON::Serializable
build_from_hash(hash : JSON::Any)
build_from_hash
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
The ID of an image file in Google Drive to use for the background image.
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Check to see if the all the properties in the model are valid @return true if the model is valid
The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
Custom attribute writer method checking allowed values (enum). @param [Object] width Object to be assigned
The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
Custom attribute writer method checking allowed values (enum). @param [Object] x_coordinate Object to be assigned
The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
Custom attribute writer method checking allowed values (enum). @param [Object] y_coordinate Object to be assigned