Styles

A Style is a custom set of branding that can be applied on a per-folder basis. Currently these support a logo per folder and an optional click-through URL for public visitors. In the future we may extend these to also support colors. If you want to see that, please let us know so we can add your vote to the list.

Show Style

SDK Method

Files::Style.find

Return Object

Style

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

Argument	Description
path string Required	Style path.

Example Request

begin
  style = Files::Style.find(path)
  # Operate on style
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Style

SDK Method

style.update

Return Object

Style

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Method Arguments

Argument	Description
file file	Logo for custom branding. Required when creating a new style. See Attaching Files to API Requests.
logo_click_href string	URL to open when a public visitor clicks the logo.

Example Request

begin
  # Find the style object by its path.
  style = Files::Style.find(path)
  style.update(
    logo_click_href: "https://www.example.com"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Style

SDK Method

style.delete

Return Object

nil

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Example Request

begin
  # Find the style object by its path.
  style = Files::Style.find(path)
  style.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The Style Object

Some of the methods above return a Style object. The attributes of this object are listed below.

Attribute	Description
id int64	Style ID
path string	Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
logo Image	Logo
logo_click_href string	URL to open when a public visitor clicks the logo
thumbnail Image	Logo thumbnail