Settings Changes

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

List Settings Changes

SDK Method

settings_change.List()

Return Values

Returns a *settings_change.Iter and an error. Range over All() to receive files_sdk.SettingsChange values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    settings_change "github.com/Files-com/files-sdk-go/v3/settingschange"
)

settingsChangeIterator, err := settings_change.List(files_sdk.SettingsChangeListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for settingsChange, err := range settingsChangeIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(settingsChange)
}

The SettingsChange Object

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

Attribute	Description
ApiKeyId int64	The API key id responsible for this change.
Changes array(string)	Markdown-formatted change messages.
CreatedAt date-time	The time this change was made.
UserId int64	The user id responsible for this change.
UserIsFilesSupport boolean	true if this change was performed by Files.com support.
UserIsFromParentSite 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.