Skip to content

Latest commit

聽

History

History
53 lines (44 loc) 路 3.82 KB

MediaAttachment.md

File metadata and controls

53 lines (44 loc) 路 3.82 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 resolved type of the attachment: * `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 A unique Flat score identifier [optional]
revision str A unique revision identifier of a score [optional]
worksheet str A 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]
part_uuid str The UUID of the instrument part selected for this attachment (for performance submissions) [optional]
sharing_mode MediaScoreSharingMode [optional] [default to MediaScoreSharingMode.READ]
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 float If the `html` is available, the width of the widget [optional]
html_height float 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 height 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 MIME type of the file [optional]
google_drive_file_id str The ID of the Google Drive File [optional]
teacher_only bool If true, this attachment is only visible to teachers. When students view the assignment, attachments with this flag will be filtered out. [optional] [default to False]

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_from_dict = MediaAttachment.from_dict(media_attachment_dict)

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