Dandelion - API Documentation - User Settings

Module name: usersettings

Index

saveloglimit

Endpoint: /api/usersettings/saveloglimit

Method: POST

Parameters: [limit]

Parameter Type Default Required
limit int 25 false

Description: Log limit is the number of logs to show per page on the dashboard, and the number of logs to return by default from a logs read command without a limit. A request without limit is effectivly resetting the setting.

Example Return Data:

{
	"data": "Success or error message"
}

Returned Values:

  • data (string) - User displayable string if the save was successful or not

Permissions Needed:

  • None

⇑ Top

savetheme

Endpoint: /api/usersettings/savetheme

Method: POST

Parameters: [theme]

Parameter Type Default Required
theme string ‘modern’ false

Description: Saves the user’s preferred theme for the official Dandelion UI. A list of available themes can be received by calling the getthemelist task. theme should be the slug of the desired theme. A request without theme will reset to the instance default (Modern is the default theme for a new instance).

Example Return Data:

{
	"data": "Success or error message"
}

Returned Values:

  • data (string) - User displayable string if the save was successful or not

Permissions Needed:

  • None

⇑ Top

getthemelist

Endpoint: /api/usersettings/getthemelist

Method: GET

Parameters: None

Description: Returns an array of theme names.

Example Return Data:

{
	"data": {
		"0": {
			"author": "Author",
			"description": "Awesome theme",
			"email": "author@example.org",
			"extends": "",
			"files": [],
			"name": "The Best Theme",
			"selected": "false",
			"slug": "best-theme",
			"version": "1.2.3"
		}
	}
}

Returned Values:

Per Theme

  • author (string) - Theme author
  • description (string) - Theme description
  • email (string) - Author/developer email
  • extends (string) - Theme this theme extends
  • files (array) - Manual mapping of page names to files
  • name (string) - Theme name
  • selected (bool) - Whether or not the user is using this theme
  • slug (string) - Shorthand identifier for theme (used to set theme)
  • version (string) - Theme version

Permissions Needed:

  • None

⇑ Top

⇐ API Documentation