Documentation

Google_Service_Fitness_Resource_UsersSessions extends Google_Service_Resource
in package

The "sessions" collection of methods.

Typical usage is: $fitnessService = new Google_Service_Fitness(...); $sessions = $fitnessService->sessions;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a session specified by the given session ID. (sessions.delete)
listUsersSessions()  : Google_Service_Fitness_ListSessionsResponse
Lists sessions previously created. (sessions.listUsersSessions)
update()  : Google_Service_Fitness_Session
Updates or insert a given session. (sessions.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a session specified by the given session ID. (sessions.delete)

public delete(string $userId, string $sessionId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$userId : string

Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

$sessionId : string

The ID of the session to be deleted.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string currentTimeMillis The client's current time in milliseconds since epoch.

Return values
mixed —

listUsersSessions()

Lists sessions previously created. (sessions.listUsersSessions)

public listUsersSessions(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Fitness_ListSessionsResponse
Parameters
$userId : string

List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string startTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but endTime is specified, all sessions from the start of time up to endTime will be returned.

opt_param

bool includeDeleted If true, and if both startTime and endTime are omitted, session deletions will be returned.

opt_param

string endTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but startTime is specified, all sessions from startTime to the end of time will be returned.

opt_param

int activityType If non-empty, only sessions with these activity types should be returned.

opt_param

string pageToken The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 30 days are returned.

Return values
Google_Service_Fitness_ListSessionsResponse —

update()

Updates or insert a given session. (sessions.update)

public update(string $userId, string $sessionId, Google_Service_Fitness_Session $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Fitness_Session
Parameters
$userId : string

Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

$sessionId : string

The ID of the session to be created.

$postBody : Google_Service_Fitness_Session
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string currentTimeMillis The client's current time in milliseconds since epoch.

Return values
Google_Service_Fitness_Session —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results