congresses

const congresses: {
  list: Promise<Event[]>;
  get: Promise<Event>;
  getAttendees: Promise<Attendee[]>;
  getAttendee: Promise<Attendee>;
  getBusinessCards: Promise<BusinessCard[]>;
  getBusinessCard: Promise<BusinessCard>;
};

Defined in: domains/congresses.ts:8

Type Declaration

list()

list(): Promise<Event[]>;

List all lead retrieval events available to the current user.

Returns

Promise<Event[]>

Array of Event objects.

Throws

MobileLockerError on network failure or server error.

get()

get(eventID): Promise<Event>;

Get a single lead retrieval event by ID.

Parameters

Parameter	Type	Description
eventID	number	The numeric ID of the event.

Returns

Promise<Event>

The matching Event.

Throws

MobileLockerError on network failure or if the event is not found.

getAttendees()

getAttendees(eventID): Promise<Attendee[]>;

Get all attendees for a lead retrieval event.

Parameters

Parameter	Type	Description
eventID	number	The numeric ID of the event.

Returns

Promise<Attendee[]>

Array of Attendee objects.

Throws

MobileLockerError on network failure or server error.

getAttendee()

getAttendee(attendeeID): Promise<Attendee>;

Get a specific attendee by ID.

Parameters

Parameter	Type	Description
attendeeID	string	The attendee’s string ID.

Returns

Promise<Attendee>

The matching Attendee.

Throws

MobileLockerError on network failure or if not found.

getBusinessCards()

getBusinessCards(): Promise<BusinessCard[]>;

Get all business cards scanned by the current user.

Returns

Promise<BusinessCard[]>

Array of BusinessCard objects.

Throws

MobileLockerError on network failure or server error.

getBusinessCard()

getBusinessCard(cardID): Promise<BusinessCard>;

Get a specific business card by ID.

Parameters

Parameter	Type	Description
cardID	string	The business card’s string ID.

Returns

Promise<BusinessCard>

The matching BusinessCard.

Throws

MobileLockerError on network failure or if not found.