Helper Methods

The following is a list of features provided in the current version of the helper:

Note: Current version does not support the full Eventbrite API.

static void Initialize (string appKey, [string userKey])
  Initializes the Eventbrite helper with the Eventbrite application key and user key. The user key is a string assigned by Eventbrite which identifies the user making the method call. A valid user key is the recommended method for user authentication with the Eventbrite API, instead of user/password.
static void Initialize (string appKey, string user, string password)
  Initializes the Eventbrite helper with the Eventbrite application key and your user and password.
static IList<Event> GetUserEventList ([string user], [string doNotDisplay], [string eventStatuses], [string ascOrDesc])
  This method returns a list of user's events.
static Process CreateNewTicket (int eventId, string name, float price, int quantity, [bool isDonation], [string description], [string startSales], [string endSales], [int includeFee], [int min], [int max])
  This method creates new fixed-price or donation ticket types. It returns the ID of the newly created ticket.
static Process CreateNewEvent (string title, string startDate, string endDate, string timezone, int organizerId, int venueId, [string description], [int privacy], [string personalizedUrl], [int capacity], [string currency], [string status], [string customHeader], [string customFooter], [string backgroundColor], [string textColor], [string linkColor], [string titleTextColor], [string boxBackgroundColor], [string boxTextColor], [string boxBorderColor], [string boxHeaderBackgroundColor], [string boxHeaderTextColor])
  This method creates a new event. It returns the ID of the newly created event.
static User GetUserInfo ([string userId], [string email])
  This method retrieves the data for a given user. If no userId or email provided, returns the information of the current API user (owner of ApiKey).
static Event GetEvent (int eventId)
  Returns the data for a given event.
@helper GetUserEventsWidget ([string user], [int count], [string title])
  This method renders a widget with a list of user's events.
@helper GetTicketWidget (int eventId, [int height])
  This method shows a widget that allows to you sell tickets to an event from your site.
@helper GetCalendarWidget (int eventId, [int width], [int height])
  This method shows a widget that allows to you display a custom calendar widget for your upcoming events. 

 

Event Information

The following is the event information:

long Id The event ID.
string Title The event title.
string Description The event description.
string Category The event category.
string Tags The event tags/keywords.
string StartDate The event start date and time, in ISO 8601 format (e.g., “2007-12-31 23:59:59″).
string EndDate The event end date and time, in ISO 8601 format (e.g., “2007-12-31 23:59:59″).
string Timezone The event timezone, as listed in the Olson timezones database (e.g. “America/New_York”).
string Created The date and time the event was created, in ISO 8601 format (e.g., “2007-12-31 23:59:59″).
string Modified The date and time the event was last modified, in ISO 8601 format (e.g., “2007-12-31 23:59:59″).
string Privacy Private for a private event, Public for a public event.
string Password Reserved for private event only.
int Capacity The total event capacity.
string Url The event registration URL.
string Logo The event logo URL.
string Status The event status (“draft”, “live”, “started”, “ended”, or “canceled”).
IList<Ticket> Tickets List of ticket types available for this event.
Venue Venue The event venue.
DateTime StartDateUtc The event start date and time in UTC.
DateTime EndDateUtc The event end date and time to UTC timezone.
DateTime StartDateLocal The event start date and time converted to the local timezone.
DateTime EndDateLocal The event start date and time converted to the local timezone.
int VisibleTickets The different tickets types currently shown to public (leaving out hidden tickets).
int TicketsSold The amount of tickets sold for the event.
int TicketsAvailable The amount of tickets available (still unsold) for the event.

Last edited Jan 10, 2011 at 2:09 PM by jsenior, version 12

Comments

No comments yet.