Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Mirror_TimelineAttachments_Resource Class Reference

The "attachments" collection of methods. More...

Inheritance diagram for Google_Service_Mirror_TimelineAttachments_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($itemId, $attachmentId, $optParams=array())
 Deletes an attachment from a timeline item.
 
 get ($itemId, $attachmentId, $optParams=array())
 Retrieves an attachment on a timeline item by item ID and attachment ID.
 
 insert ($itemId, $optParams=array())
 Adds a new attachment to a timeline item.
 
 listTimelineAttachments ($itemId, $optParams=array())
 Returns a list of attachments for a timeline item.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "attachments" collection of methods.

Typical usage is: $mirrorService = new Google_Service_Mirror(...); $attachments = $mirrorService->attachments;

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_Mirror_TimelineAttachments_Resource::delete ( $itemId,
$attachmentId,
$optParams = array() )

Deletes an attachment from a timeline item.

(attachments.delete)

Parameters
string$itemIdThe ID of the timeline item the attachment belongs to.
string$attachmentIdThe ID of the attachment.
array$optParamsOptional parameters.

◆ get()

Google_Service_Mirror_TimelineAttachments_Resource::get ( $itemId,
$attachmentId,
$optParams = array() )

Retrieves an attachment on a timeline item by item ID and attachment ID.

(attachments.get)

Parameters
string$itemIdThe ID of the timeline item the attachment belongs to.
string$attachmentIdThe ID of the attachment.
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_Attachment

◆ insert()

Google_Service_Mirror_TimelineAttachments_Resource::insert ( $itemId,
$optParams = array() )

Adds a new attachment to a timeline item.

(attachments.insert)

Parameters
string$itemIdThe ID of the timeline item the attachment belongs to.
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_Attachment

◆ listTimelineAttachments()

Google_Service_Mirror_TimelineAttachments_Resource::listTimelineAttachments ( $itemId,
$optParams = array() )

Returns a list of attachments for a timeline item.

(attachments.listTimelineAttachments)

Parameters
string$itemIdThe ID of the timeline item whose attachments should be listed.
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_AttachmentsListResponse

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