View Source GoogleApi.Books.V1.Api.Familysharing (google_api_books v0.21.0)

API calls for all endpoints tagged Familysharing.

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.

Functions

Link to this function

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

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

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
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :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
@spec books_familysharing_share(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :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, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec books_familysharing_unshare(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :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, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure