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 Function

Style.find()

Return Object

Style

Authorization Requirement

Available to all authenticated keys or sessions.

Function Arguments

Argument	Description
path string Required	Style path.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.Style;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  Style style = Style.find(path, parameters);
  // Operate on style
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Update Style

SDK Function

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.

Attribute Setters

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

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.Style;

try {
  // Find the style object by its path.
  Style style = Style.find(path, null);
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("logo_click_href", "https://www.example.com");
  style.update(parameters);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Delete Style

SDK Function

style.delete();

Return Object

No return value.

Authorization Requirement

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

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.Style;

try {
  // Find the style object by its path.
  Style style = Style.find(path, null);
  style.delete(null);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The Style Object

Some of the functions 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