EventExtended Class Reference

#import <EventExtended.h>

Inheritance diagram for EventExtended:

Instance Methods
(id)	- initWithDictionary:
(NSString *)	- JSON

Class Methods
(EventExtended *)	+ eventExtendedWithDictionary:

Properties
NSString *	activeDate
EventAddress *	address
BOOL	areRegistrantsPublic
NSString *	cancelledDate
EventContact *	contact
NSString *	createdDate
NSString *	currencyType
NSString *	deleteDate
NSString *	desc
NSString *	endDate
NSString *	googleAnalyticsKey
NSString *	googleMerchantId
NSString *	eventId
BOOL	isCalendarDisplayed
BOOL	isCheckinAvailable
BOOL	isHomePageDisplayed
BOOL	isListedInExternalDirectory
BOOL	isMapDisplayed
BOOL	isVirtualEvent
NSString *	location
NSString *	metaDataTags
NSString *	name
NSMutableArray *	notificationOptions
EventOnlineMeeting *	onlineMeeting
NSString *	payableTo
EventAddress *	paymentAddress
NSMutableArray *	paymentOptions
NSString *	paypalAccountEmail
NSString *	registrationUrl
NSString *	startDate
NSString *	status
NSString *	themeName
NSString *	timeZoneDescription
NSString *	timeZoneId
NSString *	title
NSString *	totalRegisteredCount
EventTrackInformation *	trackInformation
NSString *	twitterHashTag
NSString *	type
NSString *	updateDate
EventCurrencyTypeEnum *	eventCurrencyTypeEnum
EventStatusEnum *	eventStatusEnum
EventTypeEnum *	eventTypeEnum
EventPaymentTypeEnum *	eventPaymentTypeEnum

Method Documentation

+ (EventExtended *) eventExtendedWithDictionary:

(NSDictionary *)

dictionary

- (id) initWithDictionary:

(NSDictionary *)

dictionary

Factory method to create a Event Extended object from an dictionary

Parameters

NSDictionary

*dictionary - associative dictionary of initial properties to set

Returns

EventExtended

- (NSString *) JSON

Property Documentation

- (NSString*) activeDate

readnonatomicstrong

Date event was published or announced, in ISO-8601 format

- (EventAddress*) address

readwritenonatomicstrong

Address specifying the event location, used to determine event location on map if is_map_displayed set to true.

- (BOOL) areRegistrantsPublic

readwritenonatomicassign

Set to true allows registrants to view others who have registered for the event, Default is false

- (NSString*) cancelledDate

readnonatomicstrong

Date the event was cancelled in ISO-8601 format

- (EventContact*) contact

readwritenonatomicstrong

REQUIRED. The event host's contact information

- (NSString*) createdDate

readnonatomicstrong

Date the event was created in ISO-8601 format

- (NSString*) currencyType

readwritenonatomicstrong

Currency that the account will be paid in; although this is not a required field, it has a default value of USD. Other valid values in EventCurrencyTypeEnum

- (NSString*) deleteDate

readnonatomicstrong

Date the event was deleted in ISO-8601 format

- (NSString*) desc

readwritenonatomicstrong

Provide a brief description of the event that will be visible on the event registration form and landing page

- (NSString*) endDate

readwritenonatomicstrong

REQUIRED. The event end date, in ISO-8601 format

- (EventCurrencyTypeEnum*) eventCurrencyTypeEnum

readnonatomicstrong

Enumeration class that contains valid options for the currency element

- (NSString*) eventId

readnonatomicstrong

Unique ID of the event

- (EventPaymentTypeEnum*) eventPaymentTypeEnum

readwritenonatomicstrong

Enumeration class that contains valid options for event payment potions element

- (EventStatusEnum*) eventStatusEnum

readnonatomicstrong

Enumeration class that contains valid options for event status element

- (EventTypeEnum*) eventTypeEnum

readnonatomicstrong

Enumeration class that contains valid options for event type element

- (NSString*) googleAnalyticsKey

readwritenonatomicstrong

Enter the Google analytics key if being used to track the event registration homepage

- (NSString*) googleMerchantId

readwritenonatomicstrong

Google merchant id to which payments are made; Google Checkout is not supported for new events, only valid on events created prior to October 2013.

- (BOOL) isCalendarDisplayed

readwritenonatomicassign

Set to true to display the event on the account's calendar; Default = true

- (BOOL) isCheckinAvailable

readwritenonatomicassign

Set to true to enable registrant check-in, and indicate that the registrant attended the event; Default is false

- (BOOL) isHomePageDisplayed

readwritenonatomicassign

Indicates if the event home/landing page is displayed for the event; set to true only if a landing page has been created for the event; Default is false

- (BOOL) isListedInExternalDirectory

readwritenonatomicassign

Set to true to publish the event in external event directories such as SocialVents and EventsInAmerica; Default is false

- (BOOL) isMapDisplayed

readwritenonatomicassign

For future usage, Default = true

- (BOOL) isVirtualEvent

readwritenonatomicassign

Set to true if this is an online event; Default is false

- (NSString*) location

readwritenonatomicstrong

REQUIRED. Name of the venue or Location at which the event is being held

- (NSString*) metaDataTags

readwritenonatomicstrong

Specify keywords to improve search engine optimization (SEO) for the event; use commas to separate multiple keywords

- (NSString*) name

readwritenonatomicstrong

REQUIRED. The event filename - not visible to registrants

- (NSMutableArray*) notificationOptions

readwritenonatomicstrong

Define whether or not event notifications are sent to the contact email_address, and which notifications.

- (EventOnlineMeeting*) onlineMeeting

readwritenonatomicstrong

Online meeting details, REQUIRED if is_virtual_event is set to true

- (NSString*) payableTo

readwritenonatomicstrong

Name to which registrants paying by check must make checks payable to; REQUIRED if 'CHECK' is selected as a payment option

- (EventAddress*) paymentAddress

readwritenonatomicstrong

Address to which checks will be sent. REQUIRED if CHECK is selected as a payment option

- (NSMutableArray*) paymentOptions

readwritenonatomicstrong

Specifies the payment options available to registrants

- (NSString*) paypalAccountEmail

readwritenonatomicstrong

Email address linked to PayPal account to which payments will be made. REQUIRED if 'PAYPAL' is selected as a payment option

- (NSString*) registrationUrl

readnonatomicstrong

The URL for the event home page if one exists, otherwise it points to the event registration page

- (NSString*) startDate

readwritenonatomicstrong

REQUIRED. The event start date, in ISO-8601 format

- (NSString*) status

readnonatomicstrong

The event status, valid values are found in EventStatusEnum class

- (NSString*) themeName

readwritenonatomicstrong

The background and color theme for the event invitation, home page, and Registration form; default is Default

- (NSString*) timeZoneDescription

readwritenonatomicstrong

REQUIRED. Time zone in which the event occurs

- (NSString*) timeZoneId

readwritenonatomicstrong

REQUIRED. The event title, visible to registrants

- (NSString*) title

readwritenonatomicstrong

REQUIRED. The event title, visible to registrants valid values found at https://community.constantcontact.com/t5/Documentation/Events-Collection-and-Resource/ba-p/25081

- (NSString*) totalRegisteredCount

readnonatomicstrong

Number of event registrants

- (EventTrackInformation*) trackInformation

readwritenonatomicstrong

Use these settings to define the information displayed on the Event registration page

- (NSString*) twitterHashTag

readwritenonatomicstrong

The event's Twitter hashtag

- (NSString*) type

readwritenonatomicstrong

REQUIRED. The event type, valid values are found in EventTypeEnum class

- (NSString*) updateDate

readnonatomicstrong

Date the event was updated in ISO-8601 format

---

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

• /Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Components/EventSpot/EventExtended.h
• /Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Components/EventSpot/EventExtended.m