Settings Changes

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

List Settings Changes

SDK Method

SettingsChange.list()

Return Object

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

import SettingsChange from 'files.com/lib/models/SettingsChange';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const settingsChanges = await SettingsChange.list();
  for (const settingsChange of settingsChanges) {
    // Operate on settingsChange
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The SettingsChange Object

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

Attribute	Description
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.