Class File

Represents a single File in a Constant Contact Library

Ctct\Components\Component

Extended by

Ctct\Components\Library\File

Namespace: Ctct\Components\Library
Package: Components\Library
Author: Constant Contact
Located at Components/Library/File.php

Methods summary
`public static`	# `create( array $props )`
`public String`	# `toJson( )` Create json used for a POST/PUT request, also handles removing attributes that will cause errors if sent Create json used for a POST/PUT request, also handles removing attributes that will cause errors if sent Returns String

Methods inherited from Ctct\Components\Component
`getValue()`

Properties summary
`public String`	`$id` The ID of the file The ID of the file	#
`public String`	`$name` The name of the file The name of the file	#
`public String`	`$description` The file's description The file's description	#
`public String`	`$folder` The name of the folder that the file is in The name of the folder that the file is in	#
`public String`	`$folder_id` The ID of the folder that the file is in The ID of the folder that the file is in	#
`public Boolean`	`$is_image` Is this file an image? Is this file an image?	#
`public String`	`$type` Type of the file, must be one of "JPG", "GIF", "PDF", "PNG", "DOC", "XLS", "PPT", "DOCX", "XLSX", "PPTX" Type of the file, must be one of "JPG", "GIF", "PDF", "PNG", "DOC", "XLS", "PPT", "DOCX", "XLSX", "PPTX"	#
`public integer`	`$height` File's height in pixels, if File is an image File's height in pixels, if File is an image	#
`public integer`	`$width` File's width in pixels, if File is an image File's width in pixels, if File is an image	#
`public integer`	`$size` File's size in bytes File's size in bytes	#
`public String`	`$url` URL of the image hosted by Constant Contact URL of the image hosted by Constant Contact	#
`public String`	`$source` Source of the image, must be one of "ALL", "MY_COMPUTER", "STOCK_IMAGE", "FACEBOOK", "INSTAGRAM", "SHUTTERSTOCK", "MOBILE" Source of the image, must be one of "ALL", "MY_COMPUTER", "STOCK_IMAGE", "FACEBOOK", "INSTAGRAM", "SHUTTERSTOCK", "MOBILE"	#
`public String`	`$status` Status of the file, must be one of "ACTIVE", "PROCESSING", "UPLOADED", "VIRUS_FOUND", "FAILED", "DELETED" Status of the file, must be one of "ACTIVE", "PROCESSING", "UPLOADED", "VIRUS_FOUND", "FAILED", "DELETED"	#
`public Ctct\Components\Library\Thumbnail`	`$thumbnail` Thumbnail of the file, if File is an image Thumbnail of the file, if File is an image	#
`public String`	`$created_date` Date the file was created, in ISO-8601 format Date the file was created, in ISO-8601 format	#
`public String`	`$modified_date` Date the file was last modified, in ISO-8601 format Date the file was last modified, in ISO-8601 format	#
`public String`	`$file_type` The file's type. (PNG, JPEG, PDF, etc.) The file's type. (PNG, JPEG, PDF, etc.)	#