google_api_books v0.12.0 GoogleApi.Books.V1.Api.Familysharing View Source

API calls for all endpoints tagged Familysharing.

Link to this section Summary

Functions

Gets information regarding the family that the user is part of.

Initiates sharing of the content with the user's family. Empty response indicates success.

Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

Link to this section Functions

Link to this function

books_familysharing_get_family_info(connection, optional_params \\ [], opts \\ [])

View Source
books_familysharing_get_family_info(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.FamilyInfo.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Gets information regarding the family that the user is part of.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :source (type: String.t) - String to identify the originator of this request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Books.V1.Model.FamilyInfo{}} on success
  • {:error, info} on failure
Link to this function

books_familysharing_share(connection, optional_params \\ [], opts \\ [])

View Source
books_familysharing_share(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

Initiates sharing of the content with the user's family. Empty response indicates success.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :docId (type: String.t) - The docid to share.
    • :source (type: String.t) - String to identify the originator of this request.
    • :volumeId (type: String.t) - The volume to share.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

books_familysharing_unshare(connection, optional_params \\ [], opts \\ [])

View Source
books_familysharing_unshare(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :docId (type: String.t) - The docid to unshare.
    • :source (type: String.t) - String to identify the originator of this request.
    • :volumeId (type: String.t) - The volume to unshare.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure