import {Checkin} from 'ingresse-sdk/src/apis/checkin.js'

public class | source

Checkin

Extends:

RequestHandler → Checkin

Ingresse Checkin API

API to search for checkin.

Example:

var sdk = require('ingresse-sdk');
var ingresse = new Sdk();

// You will have access to this API
// after instantiate the SDK.
var search = ingresse.checkin;

Constructor Summary

Public Constructor
public	constructor(custom: object) Checkin Search

Member Summary

Public Members
public	settings: *

Method Summary

Public Methods
public	getEntranceReport(eventId: , sessionId: , query: {}): *
public	getReport(sessionId: string, query: object): Promise Get Session Report

Inherited Summary

From class RequestHandler
public	auth: *
public	settings: *
public	delete(path: string, query: object, data: object, headers: object): Promise Delete resource
public	get(path: string, query: object, headers: object): Promise Get resource
public	post(path: string, data: object, query: object, headers: object): Promise Post resource
public	put(path: string, data: object, query: object, headers: object): Promise Put resource
public	request(options: object): Promise Create new request promise
public	setEnv(env: string) Set Environment
public	setUrl(url: string) Set API url
public	upload(path: string, formData: object, query: object, headers: object): Promise Upload files

Public Constructors

public constructor(custom: object) source

Checkin Search

Override:

RequestHandler#constructor

Params:

Name	Type	Attribute	Description
custom	object	optional	Initialize Checkin Search settings.

Public Members

public settings: * source

Override:

RequestHandler#settings

Public Methods

public getEntranceReport(eventId: , sessionId: , query: {}): * source

Params:

Name	Type	Attribute	Description
eventId	*
sessionId	*
query	{}	optional default: {}

Return:

public getReport(sessionId: string, query: object): Promise source

Get Session Report

Params:

Name	Type	Attribute	Description
sessionId	string
query	object

Return:

Promise

Checkin

Extends:

Example:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(custom: object) source

Override:

Params:

Public Members

public settings: * source

Override:

Public Methods

public getEntranceReport(eventId: *, sessionId: *, query: {}): * source

Params:

Return:

public getReport(sessionId: string, query: object): Promise source

Params:

Return:

public getEntranceReport(eventId: , sessionId: , query: {}): * source