BlueGPSLib

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard

Accessory method that return the current access token.

Link copied to clipboard
Link copied to clipboard

Diagnostic to check if server is online

Link copied to clipboard
fun customGsonBuilder(): Gson

Facility to obtain a Gson for custom serialization or deserialization. This method combines the registration of these class Widget and AbstractComponent

Link copied to clipboard
suspend fun downloadImage(imageUrl: String): Resource<Bitmap>

Facility to automatically fetch usable Image directly from network

Link copied to clipboard

Return a RealtimeAreaElementResponse that contains the list of areas where a realtime element (Tag, Element, etc.) is located.

Link copied to clipboard
suspend fun getAreasList(search: String? = null, type: String? = null, isDesc: Boolean? = null, order: String? = null): Resource<List<BGPArea>>

Return a list of areas

Link copied to clipboard
suspend fun getAreasWithTagsInside(areaFilterRequest: AreaFilterRequest = AreaFilterRequest()): Resource<List<AreaWithTagsInside>>

Return a list of areas with a list of inside tags

Link copied to clipboard

Return a list of buildings

Link copied to clipboard

Return the current position of a tag inside a building

Link copied to clipboard

Asks for a device configuration for advertising

Link copied to clipboard
suspend fun getFilter(type: FilterType): Resource<Filter>

Return filter for the selected type

Link copied to clipboard

Return filter for the resource type

Link copied to clipboard
suspend fun getFilterSection(sectionTypes: List<SectionFilterType>? = null): Resource<List<SectionFilter>>

Return filter for section screen

Link copied to clipboard

Return a jwt token for use Schindler section return a Schindler

Link copied to clipboard
suspend fun getLanguage(name: String): Resource<Language>

Return a single dictionary

Link copied to clipboard

Return a list of all dictionaries

Link copied to clipboard
suspend fun getMapsList(search: String? = null, staticResourceTypeList: List<BGPResourceType>? = null, isDesc: Boolean? = null, order: String? = null): Resource<List<BGPMap>>

Return all list of maps present in the building

Link copied to clipboard

Asks for a device configuration for advertising

Link copied to clipboard

Return all list of areas present in the building

Link copied to clipboard

Get auto destination for the logged user if exist return a AutoDestination

Link copied to clipboard

Return all associated profiles to the logged user return a response ProfileAction

Link copied to clipboard
fun getUUID(): String?

return the UUID if set, null otherwise

Link copied to clipboard
fun initSDK(sdkEnvironment: SdkEnvironment, context: Context, enabledNetworkLogs: Boolean = false)

Init the BlueGPS SDK.

Link copied to clipboard

Accessory method that return true if a session is valid, false otherwise.

Link copied to clipboard

check if refresh token is still valid.

Link copied to clipboard

Send GPS position data to cloud.

Link copied to clipboard
fun saveUserTagId(tagId: String)

Accessory function to save the tagId assigned to the user

Link copied to clipboard
suspend fun search(filter: Filter): Resource<List<Resource>>

Search a generic resource

Link copied to clipboard
suspend fun sendPositionAndCompass(bgpGpsPosition: BGPGpsPosition? = null, compass: Double? = null, compassAnimation: Int = 0)
Link copied to clipboard
suspend fun setLanguage(language: String): Resource<SyHttpResponse>

Send the current language of the user's mobile device to the backend. Used to send localized notifications to the mobile device.

Link copied to clipboard
fun startDiagnostic(checkTimeout: Int = 30000, diagnosticSseRequest: DiagnosticSseRequest, onComplete: (DiagnosticSseResponse) -> Any, onTagTracking: (Map<String, DiagnosticStatus>?) -> Any? = null, onCheck: (String?) -> Unit? = null, onStop: (String) -> Unit? = null)

Accessory method for activate the diagnostic. If a previously job is active, its stopped and a new diagnostic started with the new configuration.

Link copied to clipboard

Accessory method for deactivate the diagnostic.

Link copied to clipboard

Utility function for update the SDK Environment

Link copied to clipboard

Accessory function that return the tagId assigned to the user if exist, null otherwise

Inherited functions

Link copied to clipboard

Returns the agenda for the selected elements and for the selected date.

Link copied to clipboard

Returns the number of notifications to read

Link copied to clipboard

Delete the notifications

Link copied to clipboard

Delete a schedule

Link copied to clipboard

Delete a ticket

Link copied to clipboard
suspend fun BlueGPSLib.findResources(isDesc: Boolean?, mapId: Int?, order: String?, search: String?, subType: String?, type: String?, roomId: Int?, roomName: String?): Resource<List<GenericResource>>
suspend fun BlueGPSLib.findResources(hasPosition: Boolean? = null, isDesc: Boolean? = null, mapId: Int? = null, order: String? = null, search: String? = null, subTypes: List<String>? = null, types: List<String>? = null, roomId: Int? = null, roomName: String? = null): Resource<List<GenericResource>>

Asks for a list of resources

Link copied to clipboard
suspend fun BlueGPSLib.getAgendaDay(id: String, date: String, scheduleTypes: MutableList<ScheduleType>? = null): Resource<DaySchedule>

Returns the agenda for the selected element.

Link copied to clipboard
suspend fun BlueGPSLib.getAgendaMy(dateStart: String? = null, dateEnd: String? = null): Resource<List<DaySchedule>>

Return all agenda for the logged user.

Link copied to clipboard

Return exactly all agenda for the logged user based on the current time

Link copied to clipboard
suspend fun BlueGPSLib.getAvailableSlots(resourceId: String? = null, bookingId: String? = null, resourceType: ResourceType, date: String? = null): Resource<List<List<String>>>

Get available time slots for the specific resource

Link copied to clipboard

Return a navigation route

Link copied to clipboard

Returns a list of user to invite.

Link copied to clipboard

Return generic element associated with this code

Link copied to clipboard

Returns a list of controllable items, passing a filter if necessary

Link copied to clipboard

Get the filter to set a do not disturb element

Link copied to clipboard

Return a resource for the selected id

Link copied to clipboard
suspend fun BlueGPSLib.getHomeMy(buildingId: String? = null): Resource<List<Container>>

Returns all widgets to build the home screen

Link copied to clipboard

Return a filter for locker

Link copied to clipboard

Return a list of navigation path

Link copied to clipboard

Request looking for nearest booking

Link copied to clipboard

Get a schedule by id

Link copied to clipboard
suspend fun BlueGPSLib.getSearchableTrackTag(search: String? = null, tagId: String? = null, label: String? = null, nfcCode: String? = null): Resource<List<TrackTag>>

Get a searchable track tag list filtering also by NFC code Return a list of TrackTag

Link copied to clipboard

Return the ticket detail

Link copied to clipboard

Return the entire form that the interface will have to build.

Link copied to clipboard
suspend fun BlueGPSLib.getTicketMy(search: String? = null, manager: String? = null, status: String? = null): Resource<List<Ticket>>

Return all tickets for the logged user.

Link copied to clipboard

Returns the types for tickets ("INTERNAL", "IVIVA").

Link copied to clipboard
suspend fun BlueGPSLib.getTrackElement(trackElementId: Int): Resource<TrackedElement>

Returns a track element passing a corresponding id

Link copied to clipboard
suspend fun BlueGPSLib.getTrackElementPage(type: String? = null, groupIds: List<Int>? = null, search: String? = null, isDesc: Boolean? = null, order: String? = null): Resource<PageTrackedElement>

Return a Track Element Page

Link copied to clipboard
suspend fun BlueGPSLib.getTrackElements(type: String? = null, groupIds: List<Int>? = null, search: String? = null, isDesc: Boolean? = null, order: String? = null): Resource<List<TrackElement>>

Return a Track Element list

Link copied to clipboard

Returns a tag history passing a corresponding id

Link copied to clipboard

Return a list of track group

Link copied to clipboard

Return an AbstractComponent that represent the visitor form. Used to build the UI.

Link copied to clipboard

Return an AbstractComponent that represent the visit form flow. Used to build the UI.

Link copied to clipboard

Returns a specific widget

Link copied to clipboard

Returns all widgets

Link copied to clipboard
suspend fun BlueGPSLib.getWidgetRoom(roomId: String, isHorizontal: Boolean? = false): Resource<AbstractComponent>

Returns all widgets for a specific room

Link copied to clipboard

Returns all available notifications

Link copied to clipboard

add or remove a resource as favourite

Link copied to clipboard

For update the status of the notifications

Link copied to clipboard

For register the device and the push token for receive notifications

Link copied to clipboard

Release the locker resource

Link copied to clipboard
suspend fun BlueGPSLib.saveTicket(manager: String, image: MultipartBody.Part? = null, sound: MultipartBody.Part? = null, form: MultipartBody.Part?): Resource<List<FormTicket>>

Save ticket

Link copied to clipboard

Save the visitor form.

Link copied to clipboard

Save the current visitor to BlueGPS backend.

Link copied to clipboard

To update value of a widget

Link copied to clipboard

Save a reservation

Link copied to clipboard

Check if a schedule have a problem after change a value like date or time slot.

Link copied to clipboard

Search for a visitor by email.

Link copied to clipboard

Set currentValue for specified item

Link copied to clipboard

To set a do not disturb or out of office

Link copied to clipboard

Request for booking a locker

Link copied to clipboard
fun BlueGPSLib.startHomeWidgetEvent(checkTimeout: Int = 30000, tagId: String, callbackHandler: (Event) -> Unit? = null, onStop: (String) -> Unit? = null)

Accessory method for Stream events for widgets of a specific user If a previously job is active, its stopped and a new job started with the new configuration.

Link copied to clipboard
fun BlueGPSLib.startNotifyEventChanges(streamType: StreamType, outputEvents: List<String>, tagIdList: List<String>? = null, callbackHandler: (Event) -> Unit? = null, onStop: (String) -> Unit? = null)

Accessory method for activate the notify generic event. If a previously job is active, its stopped and a new job started with the new configuration.

Link copied to clipboard
fun BlueGPSLib.startNotifyPositionChanges(checkTimeout: Int = 30000, callbackHandler: (Position) -> Unit? = null, onStopEvent: (String) -> Unit? = null)

Accessory method for activate the notify position change. If a previously job is active, its stopped and a new job started with the new configuration.

Link copied to clipboard
fun BlueGPSLib.startNotifyRegionChanges(checkTimeout: Int = 30000, tags: List<String>? = null, regions: List<BGPRegion>, callbackHandler: (MutableMap<String, MutableList<BGPRegion>>) -> Unit, onStop: (String) -> Unit? = null)

Accessory method for activate the notify region. If a previously job is active, its stopped and a new job started with the new configuration.

Link copied to clipboard
fun BlueGPSLib.startWidgetIdEvent(checkTimeout: Int = 30000, widgetId: String, callbackHandler: (Event) -> Unit? = null, onStop: (String) -> Unit? = null)

Accessory method for Stream events for a specific widget. If a previously job is active, its stopped and a new job started with the new configuration.

Link copied to clipboard
fun BlueGPSLib.startWidgetRoomIdEvent(checkTimeout: Int = 30000, roomId: String, callbackHandler: (Event) -> Unit? = null, onStop: (String) -> Unit? = null)

Accessory method for Stream events of room widgets. If a previously job is active, its stopped and a new job started with the new configuration.

Link copied to clipboard

Accessory method for deactivate the stream home widget event job.

Link copied to clipboard

Accessory method for deactivate the Notify generic job.

Link copied to clipboard

Accessory method for deactivate the Notify position job.

Link copied to clipboard

Accessory method for deactivate the Notify region job.

Link copied to clipboard

Accessory method for deactivate the widget id event job.

Link copied to clipboard

Accessory method for deactivate the widget room id event job.

Link copied to clipboard

Unlock the locker resource

Link copied to clipboard

update the entire form that the interface will have to build.