 |
Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
|
Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
The "playlists" collection of methods. More...
Public Member Functions | |
| call ($name, $arguments, $expected_class=null) | |
| TODO: This function needs simplifying. | |
| delete ($id, $optParams=array()) | |
| Deletes a playlist. | |
| insert ($part, Google_Service_YouTube_Playlist $postBody, $optParams=array()) | |
| Creates a playlist. | |
| listPlaylists ($part, $optParams=array()) | |
| Returns a collection of playlists that match the API request parameters. | |
| update ($part, Google_Service_YouTube_Playlist $postBody, $optParams=array()) | |
| Modifies a playlist. | |
Protected Member Functions | |
| convertToArrayAndStripNulls ($o) | |
The "playlists" collection of methods.
Typical usage is: $youtubeService = new Google_Service_YouTube(...); $playlists = $youtubeService->playlists;
|
inherited |
TODO: This function needs simplifying.
| $name | |
| $arguments | |
| $expected_class | - optional, the expected class name |
| Google_Http_Request|expected_class |
| Google_Exception |
| Google_Service_YouTube_Playlists_Resource::delete | ( | $id, | |
| $optParams = array() ) |
Deletes a playlist.
(playlists.delete)
| string | $id | The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID. |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_Playlists_Resource::insert | ( | $part, | |
| Google_Service_YouTube_Playlist | $postBody, | ||
| $optParams = array() ) |
Creates a playlist.
(playlists.insert)
| string | $part | The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. |
| Google_Playlist | $postBody | |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_Playlist |
| Google_Service_YouTube_Playlists_Resource::listPlaylists | ( | $part, | |
| $optParams = array() ) |
Returns a collection of playlists that match the API request parameters.
For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. (playlists.listPlaylists)
| string | $part | The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. |
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties.
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. @opt_param string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. @opt_param string channelId This value indicates that the API should only return the specified channel's playlists. @opt_param bool mine Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user. @opt_param string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set. @opt_param string pageToken The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. @opt_param string hl The hl parameter should be used for filter out the properties that are not in the given language. Used for the snippet part. @opt_param string id The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID.
| Google_Service_YouTube_PlaylistListResponse |
| Google_Service_YouTube_Playlists_Resource::update | ( | $part, | |
| Google_Service_YouTube_Playlist | $postBody, | ||
| $optParams = array() ) |
Modifies a playlist.
For example, you could change a playlist's title, description, or privacy status. (playlists.update)
| string | $part | The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. |
Note that this method will override the existing values for mutable properties that are contained in any parts that the request body specifies. For example, a playlist's description is contained in the snippet part, which must be included in the request body. If the request does not specify a value for the snippet.description property, the playlist's existing description will be deleted.
| Google_Playlist | $postBody | |
| array | $optParams | Optional parameters. |
@opt_param string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
| Google_Service_YouTube_Playlist |
1.11.0