Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.45 KB

MediaAttachment.md

File metadata and controls

51 lines (42 loc) · 3.45 KB

MediaAttachment

Media attachment. The API will automatically resolve the details, oEmbed, and media available if possible and return them in this object

Properties

Name Type Description Notes
type str The type of the assignment resolved: * `rich`, `photo`, `video` are automatically resolved as `link` * A `flat` attachment is a score document where the unique identifier will be specified in the `score` property. Its sharing mode will be provided in the `sharingMode` property.
score str An unique Flat score identifier [optional]
revision str An unique revision identifier of a score [optional]
worksheet str An unique worksheet identifier [optional]
dedicated bool True if the resource is dedicated for the assignment (for scores and worksheets), meaning on the user-side this one is stored in the assignment [optional]
track str A unique track identifier [optional]
sharing_mode MediaScoreSharingMode [optional]
lock_score_template bool To be used with a score attached in `sharingMode` `copy` (score used as template). If true, students won't be able to change the original notes of the template. [optional]
title str The resolved title of the attachment [optional]
description str The resolved description of the attachment [optional]
html str If the attachment type is `rich` or `video`, the HTML code of the media to display [optional]
html_width str If the `html` is available, the width of the widget [optional]
html_height str If the `html` is available, the height of the widget [optional]
url str The url of the attachment [optional]
thumbnail_url str If the attachment type is `rich`, `video`, `photo` or `link`, a displayable thumbnail for this attachment [optional]
thumbnail_width int If the `thumbnailUrl` is available, the width of the thumbnail [optional]
thumbnail_height int If the `thumbnailUrl` is available, the width of the thumbnail [optional]
author_name str The resolved author name of the attachment [optional]
author_url str The resolved author url of the attachment [optional]
icon_url str The URL of the icon [optional]
mime_type str The mine type of the file [optional]
google_drive_file_id str The ID of the Google Drive File [optional]

Example

from flat_api.models.media_attachment import MediaAttachment

# TODO update the JSON string below
json = "{}"
# create an instance of MediaAttachment from a JSON string
media_attachment_instance = MediaAttachment.from_json(json)
# print the JSON string representation of the object
print MediaAttachment.to_json()

# convert the object into a dict
media_attachment_dict = media_attachment_instance.to_dict()
# create an instance of MediaAttachment from a dict
media_attachment_form_dict = media_attachment.from_dict(media_attachment_dict)

[Back to Model list] [Back to API list] [Back to README]