enableNoteShare method

Future<ShareSettings?> enableNoteShare(
  1. String id, {
  2. String? accountId,
  3. String? xWorkspaceID,
  4. EnableShareRequest? enableShareRequest,
})

Enable (or update password on) public sharing.

Owner-only. Calling with an empty body or setPassword: false flips the note public without changing the password. With setPassword: true, applies password (empty string clears).

Parameters:

  • String id (required): Note id.

  • String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with provider. If omitted on a list endpoint the call fans out across every connected account.

  • String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • EnableShareRequest enableShareRequest:

Implementation

Future<ShareSettings?> enableNoteShare(String id, { String? accountId, String? xWorkspaceID, EnableShareRequest? enableShareRequest, }) async {
  final response = await enableNoteShareWithHttpInfo(id,  accountId: accountId, xWorkspaceID: xWorkspaceID, enableShareRequest: enableShareRequest, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'ShareSettings',) as ShareSettings;

  }
  return null;
}