Revision control
Copy as Markdown
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
[Custom]
typedef string RsJsonObject;
namespace remote_settings {};
[Enum]
interface RemoteSettingsServer {
Prod();
Stage();
Dev();
Custom(string url);
};
dictionary RemoteSettingsConfig {
string collection_name;
string? bucket_name = null;
string? server_url = null;
RemoteSettingsServer? server = null;
};
dictionary RemoteSettingsResponse {
sequence<RemoteSettingsRecord> records;
u64 last_modified;
};
dictionary RemoteSettingsRecord {
string id;
u64 last_modified;
boolean deleted;
Attachment? attachment;
RsJsonObject fields;
};
dictionary Attachment {
string filename;
string mimetype;
string location;
string hash;
u64 size;
};
[Error]
enum RemoteSettingsError {
"JSONError",
"FileError",
"RequestError",
"UrlParsingError",
"BackoffError",
"ResponseError",
"AttachmentsUnsupportedError",
"ConfigError",
};
interface RemoteSettings {
// Construct a new Remote Settings client with the given configuration.
[Throws=RemoteSettingsError]
constructor(RemoteSettingsConfig remote_settings_config);
// Fetch all records for the configuration this client was initialized with.
[Throws=RemoteSettingsError]
RemoteSettingsResponse get_records();
// Fetch all records added to the server since the provided timestamp,
// using the configuration this client was initialized with.
[Throws=RemoteSettingsError]
RemoteSettingsResponse get_records_since(u64 timestamp);
// Download an attachment with the provided id to the provided path.
[Throws=RemoteSettingsError]
void download_attachment_to_path(string attachment_id, string path);
};