Instance settings

vaze.settings reads and changes what applies to everyone on the instance. These calls need a client that acts as a signed-in user whose role holds settings:manage. Every method returns the response envelope.

Read the settings

const { data } = await vaze.settings.get();
// data => {
//   defaultVisibility: "public" | "private",
//   visibilityCounts: { public: number, private: number },
//   limits: Limits,
// }

limits holds byte, second and day values; the API reference lists each one with its unit and minimum.

Change the settings

Pass defaultVisibility, limits or both. Limits left out keep their current values. The response is the updated settings.

const { data, error } = await vaze.settings.update({
  defaultVisibility: "private",
  limits: { maxUploadSize: 1024 ** 3, activityRetentionDays: 30 },
});

Apply a visibility to every file

A new default only affects files uploaded from then on. To change existing files too:

const { data } = await vaze.settings.applyVisibility("private");
// data => { updated: 120 }