 |
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 "channelSections" collection of methods. More...
Public Member Functions | |
| call ($name, $arguments, $expected_class=null) | |
| TODO: This function needs simplifying. | |
| delete ($id, $optParams=array()) | |
| Deletes a channelSection. | |
| insert ($part, Google_Service_YouTube_ChannelSection $postBody, $optParams=array()) | |
| Adds a channelSection for the authenticated user's channel. | |
| listChannelSections ($part, $optParams=array()) | |
| Returns channelSection resources that match the API request criteria. | |
| update ($part, Google_Service_YouTube_ChannelSection $postBody, $optParams=array()) | |
| Update a channelSection. | |
Protected Member Functions | |
| convertToArrayAndStripNulls ($o) | |
The "channelSections" collection of methods.
Typical usage is: $youtubeService = new Google_Service_YouTube(...); $channelSections = $youtubeService->channelSections;
|
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_ChannelSections_Resource::delete | ( | $id, | |
| $optParams = array() ) |
Deletes a channelSection.
(channelSections.delete)
| string | $id | The id parameter specifies the YouTube channelSection ID for the resource that is being deleted. In a channelSection resource, the id property specifies the YouTube channelSection 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_ChannelSections_Resource::insert | ( | $part, | |
| Google_Service_YouTube_ChannelSection | $postBody, | ||
| $optParams = array() ) |
Adds a channelSection for the authenticated user's channel.
(channelSections.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. |
The part names that you can include in the parameter value are snippet and contentDetails.
| Google_ChannelSection | $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_ChannelSection |
| Google_Service_YouTube_ChannelSections_Resource::listChannelSections | ( | $part, | |
| $optParams = array() ) |
Returns channelSection resources that match the API request criteria.
(channelSections.listChannelSections)
| string | $part | The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. |
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. 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 channelId The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections. @opt_param bool mine Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections. @opt_param string hl The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method. @opt_param string id The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID.
| Google_Service_YouTube_ChannelSectionListResponse |
| Google_Service_YouTube_ChannelSections_Resource::update | ( | $part, | |
| Google_Service_YouTube_ChannelSection | $postBody, | ||
| $optParams = array() ) |
Update a channelSection.
(channelSections.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. |
The part names that you can include in the parameter value are snippet and contentDetails.
| Google_ChannelSection | $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_ChannelSection |
1.11.0