Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Fitness_UsersSessions_Resource Class Reference

The "sessions" collection of methods. More...

Inheritance diagram for Google_Service_Fitness_UsersSessions_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($userId, $sessionId, $optParams=array())
 Deletes a session specified by the given session ID.
 
 listUsersSessions ($userId, $optParams=array())
 Lists sessions previously created.
 
 update ($userId, $sessionId, Google_Service_Fitness_Session $postBody, $optParams=array())
 Updates or insert a given session.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "sessions" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Fitness_UsersSessions_Resource::delete ( $userId,
$sessionId,
$optParams = array() )

Deletes a session specified by the given session ID.

(sessions.delete)

Parameters
string$userIdDelete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.
string$sessionIdThe ID of the session to be deleted.
array$optParamsOptional parameters.

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

◆ listUsersSessions()

Google_Service_Fitness_UsersSessions_Resource::listUsersSessions ( $userId,
$optParams = array() )

Lists sessions previously created.

(sessions.listUsersSessions)

Parameters
string$userIdList sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.
array$optParamsOptional parameters.

@opt_param string pageToken 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. @opt_param string endTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. @opt_param bool includeDeleted If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields. @opt_param string startTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response.

Return values
Google_Service_Fitness_ListSessionsResponse

◆ update()

Google_Service_Fitness_UsersSessions_Resource::update ( $userId,
$sessionId,
Google_Service_Fitness_Session $postBody,
$optParams = array() )

Updates or insert a given session.

(sessions.update)

Parameters
string$userIdCreate sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.
string$sessionIdThe ID of the session to be created.
Google_Session$postBody
array$optParamsOptional parameters.

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

Return values
Google_Service_Fitness_Session

The documentation for this class was generated from the following file: