Home Reference Source
      import { Monitoring } from 'buildthing-ble-sdk'
    
public class | source

Monitoring

Extends:

EventEmitter → Monitoring

리전 모니터링 을 책임지는 클래스

스캔 시, Manager에서 호출하여 상태 업데이트

특정 Beacon(Region) 모니터링 및 "enter", "exit", "update" 콜백 호출

Constructor Summary

Public Constructor
public

constructor(manager: Manager)

모티터링 초기값 설정

Member Summary

Public Members
public

리전 상태들이 저장되어있는 Map (Key : Region Id, Value : RegionMonitoringState)

Method Summary

Public Methods
public

모니터링 하는 새로운 리전을 추가하는 함수

public

clear()

모니터링하는 모든 리전을 제거 하는 함수

public

모니터링 하고있는 리전중에 스캔된 비콘과 맞는 리전이 있는지 확인해서 해당 리전들을 배열 형태로 리턴하는 함수

public

현재 모니터링 하고 있는 리전과 리전 모니터링 상태를 map 형태로 가져오는 함수

public

모니터링 하고있는 리전의 수 를 가져오는 함수

public

현재 모니터링 하고 있는 리전을 배열 형태로 가져오는 함수

public

모니터링 하는 리전에서 기존 리전을 제거 하는 함수

public

리전 안에 있는지 여부를 발견(스캔)된 비콘에 따라 업데이트 하는 함수

public

리전 밖에 있는 여부를 확인하여 업데이트 하는 함수

public

updateState(region: Region, state: boolean)

모니터링 하고있는 리전들의 상태를 업데이트 하는 함수

Inherited Summary

From class EventEmitter
public

등록된 이벤트 Set 을 저장 할 객체

public

emit(eventName: string, args: Object)

이벤트를 발생시켜 해당 이벤트에 등록된 이벤트 콜백 함수를 호출 하는 함수

public

off(eventName: string, fn: function)

전달받은 이벤트 명 과 이벤트 콜백함수 통해서 이벤트 Set 에서 이벤트 콜백 함수를 제거하는 함수

public

on(eventName: string, fn: function)

전달받은 이벤트 명으로, 전달받은 이벤트 콜백 함수를 등록하는 함수

public

once(eventName: string, fn: function)

이벤트가 발생한 경우 한번만 호출되는 이벤트 콜백 함수를 등록 하는 함수

Public Constructors

public constructor(manager: Manager) source

모티터링 초기값 설정

Override:

EventEmitter#constructor

Params:

NameTypeAttributeDescription
manager Manager

모니터링을 사용하는 매니저 인스턴스

Public Members

public regionStateMap: Map<id, RegionMonitoringState> source

리전 상태들이 저장되어있는 Map (Key : Region Id, Value : RegionMonitoringState)

Public Methods

public addRegion(region: Region): RegionMonitoringState source

모니터링 하는 새로운 리전을 추가하는 함수

Params:

NameTypeAttributeDescription
region Region

추가하려는 리전

Return:

RegionMonitoringState

새로운 리전의 regionMonitoringState 값.

public clear() source

모니터링하는 모든 리전을 제거 하는 함수

public getMatchedRegions(beacon: Beacon): Array<Region> source

모니터링 하고있는 리전중에 스캔된 비콘과 맞는 리전이 있는지 확인해서 해당 리전들을 배열 형태로 리턴하는 함수

Params:

NameTypeAttributeDescription
beacon Beacon

스캔된 비콘

Return:

Array<Region>

해당 비콘이 있는 리전 배열

public getRegionMonitoringStateMap(): Map<id, RegionMonitoringState> source

현재 모니터링 하고 있는 리전과 리전 모니터링 상태를 map 형태로 가져오는 함수

Return:

Map<id, RegionMonitoringState>

현재 모니터링 하고 있는 리전과 리전 모니터링 상태

public getRegionSize(): number source

모니터링 하고있는 리전의 수 를 가져오는 함수

Return:

number

모니터링 하고있는 리전의 수

public getRegions(): Array<Region> source

현재 모니터링 하고 있는 리전을 배열 형태로 가져오는 함수

Return:

Array<Region>

현재 모니터링 하고 있는 리전을 배열

public removeRegion(region: Region): boolean source

모니터링 하는 리전에서 기존 리전을 제거 하는 함수

Params:

NameTypeAttributeDescription
region Region

제거 하려는 리전

Return:

boolean

제거 했을경우 true, 존재하지 않으면 false

public updateInsideRegion(beacon: Beacon) source

리전 안에 있는지 여부를 발견(스캔)된 비콘에 따라 업데이트 하는 함수

Params:

NameTypeAttributeDescription
beacon Beacon

발견(스캔)된 비콘

public updateOutsideRegion() source

리전 밖에 있는 여부를 확인하여 업데이트 하는 함수

public updateState(region: Region, state: boolean) source

모니터링 하고있는 리전들의 상태를 업데이트 하는 함수

Params:

NameTypeAttributeDescription
region Region

업데이트 하려는 리전

state boolean

리전 안에 있는지 여부