 |
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 "subscriptions" collection of methods. More...
Public Member Functions | |
| call ($name, $arguments, $expected_class=null) | |
| TODO: This function needs simplifying. | |
| delete ($id, $optParams=array()) | |
| Deletes a subscription. | |
| insert ($part, Google_Service_YouTube_Subscription $postBody, $optParams=array()) | |
| Adds a subscription for the authenticated user's channel. | |
| listSubscriptions ($part, $optParams=array()) | |
| Returns subscription resources that match the API request criteria. | |
Protected Member Functions | |
| convertToArrayAndStripNulls ($o) | |
The "subscriptions" collection of methods.
Typical usage is: $youtubeService = new Google_Service_YouTube(...); $subscriptions = $youtubeService->subscriptions;
|
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_Subscriptions_Resource::delete | ( | $id, | |
| $optParams = array() ) |
Deletes a subscription.
(subscriptions.delete)
| string | $id | The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID. |
| array | $optParams | Optional parameters. |
| Google_Service_YouTube_Subscriptions_Resource::insert | ( | $part, | |
| Google_Service_YouTube_Subscription | $postBody, | ||
| $optParams = array() ) |
Adds a subscription for the authenticated user's channel.
(subscriptions.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_Subscription | $postBody | |
| array | $optParams | Optional parameters. |
| Google_Service_YouTube_Subscription |
| Google_Service_YouTube_Subscriptions_Resource::listSubscriptions | ( | $part, | |
| $optParams = array() ) |
Returns subscription resources that match the API request criteria.
(subscriptions.listSubscriptions)
| string | $part | The part parameter specifies a comma-separated list of one or more subscription 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 subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested 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 The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions. @opt_param bool mine Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions. @opt_param string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set. @opt_param string forChannelId The forChannelId parameter specifies a comma- separated list of channel IDs. The API response will then only contain subscriptions matching those channels. @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 bool mySubscribers Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user. @opt_param string order The order parameter specifies the method that will be used to sort resources in the API response. @opt_param string id The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.
| Google_Service_YouTube_SubscriptionListResponse |
1.11.0