GoogleApi.FCM.V1.Api.Projects (google_api_fcm v0.8.2) View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

Send a message to specified target (a registration token, topic or condition).

Link to this section Functions

Link to this function

fcm_projects_messages_send(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

fcm_projects_messages_send(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.FCM.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Send a message to specified target (a registration token, topic or condition).

Parameters

  • connection (type: GoogleApi.FCM.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of projects/{project_id}. For legacy support, the numeric project number with no padding is also supported in the format of projects/{project_number}.
  • 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").
    • :body (type: GoogleApi.FCM.V1.Model.SendMessageRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FCM.V1.Model.Message{}} on success
  • {:error, info} on failure