Settings Changes

A SettingsChange is any change in your site caused by any user.

List Settings Changes

SDK Method

Files::SettingsChange.list

Return Object

List<SettingsChange>

Authorization Requirement

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

Additional Arguments

Example Request

begin
  settings_changes = Files::SettingsChange.list
  settings_changes.auto_paging_each do |settings_change|
    # Operate on settings_change
  end
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 SettingsChange Object

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

AttributeDescription
api_key_id
int64		The API key id responsible for this change.
changes
array(string)		Markdown-formatted change messages.
created_at
date-time		The time this change was made.
user_id
int64		The user id responsible for this change.
user_is_files_support
boolean		true if this change was performed by Files.com support.
user_is_from_parent_site
boolean		true if this change was performed by a user on a parent site.
username
string		The username of the user responsible for this change.