google_api_plus v0.1.0 GoogleApi.Plus.V1.Api.Activities View Source
API calls for all endpoints tagged Activities
.
Link to this section Summary
Functions
Get an activity
List all of the activities in the specified collection for a particular user
Search public activities
Link to this section Functions
Link to this function
plus_activities_get(connection, activity_id, opts \\ [])
View Source
plus_activities_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.Plus.V1.Model.Activity.t()} | {:error, Tesla.Env.t()}
Get an activity.
Parameters
- connection (GoogleApi.Plus.V1.Connection): Connection to server
- activity_id (String.t): The ID of the activity to get.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Plus.V1.Model.Activity{}} on success {:error, info} on failure
Link to this function
plus_activities_list(connection, user_id, collection, opts \\ [])
View Source
plus_activities_list(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, GoogleApi.Plus.V1.Model.ActivityFeed.t()} | {:error, Tesla.Env.t()}
List all of the activities in the specified collection for a particular user.
Parameters
- connection (GoogleApi.Plus.V1.Connection): Connection to server
- user_id (String.t): The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.
- collection (String.t): The collection of activities to list.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :maxResults (integer()): The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
- :pageToken (String.t): The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
Returns
{:ok, %GoogleApi.Plus.V1.Model.ActivityFeed{}} on success {:error, info} on failure
Link to this function
plus_activities_search(connection, query, opts \\ [])
View Source
plus_activities_search(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.Plus.V1.Model.ActivityFeed.t()} | {:error, Tesla.Env.t()}
Search public activities.
Parameters
- connection (GoogleApi.Plus.V1.Connection): Connection to server
- query (String.t): Full-text search query string.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :language (String.t): Specify the preferred language to search with. See search language codes for available values.
- :maxResults (integer()): The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
- :orderBy (String.t): Specifies how to order search results.
- :pageToken (String.t): The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
Returns
{:ok, %GoogleApi.Plus.V1.Model.ActivityFeed{}} on success {:error, info} on failure