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

Region

Region을 정의한다.

Example:

How to Use
 var region = new Region(data)

Constructor Summary

Public Constructor
public

Region의 초기 정보를 설정한다.

Member Summary

Public Members
public

beacons: *

public

Region의 고유 식별자

public

Region의 major값

public

Region의 minor값

public

Region의 namespaceId값

public

Region의 uuid값

Method Summary

Public Methods
public

addBeacons(beacons: *)

public

getBeacons(): *

public

isEqual(region: Region): boolean

전달 받은 Region이 현재 Region과 같은지 판별한다.

public

전달 받은 비콘이 현재 Region에 속하는지 판별한다.

public

removeBeacons(beacons: *)

public

setBeacons(beacons: *): *

public

Region의 식별자를 반환한다.

Public Constructors

public constructor(data: Object) source

Region의 초기 정보를 설정한다.

Params:

NameTypeAttributeDescription
data Object

Region의 정보를 담은 객체

data.id string
  • nullable: false

Region의 고유 식별자, 이름

data.major number

Region의 major값

data.minor number

Region의 minor값

data.uuid string
  • nullable: true

Region의 uuid값

data.namespaceId string
  • nullable: true

Region의 namespaceId값

Public Members

public beacons: * source

public id: string source

Region의 고유 식별자

public major: number source

Region의 major값

public minor: number source

Region의 minor값

public namespaceId: string source

Region의 namespaceId값

public uuid: string source

Region의 uuid값

Public Methods

public addBeacons(beacons: *) source

Params:

NameTypeAttributeDescription
beacons *

public getBeacons(): * source

Return:

*

public isEqual(region: Region): boolean source

전달 받은 Region이 현재 Region과 같은지 판별한다.

Params:

NameTypeAttributeDescription
region Region

판별할 Region 객체

Return:

boolean

현재 Region과 동일한 Region이면 true, 아니면 false

public isMatchedBeacon(beacon: Beacon): boolean source

전달 받은 비콘이 현재 Region에 속하는지 판별한다.

Params:

NameTypeAttributeDescription
beacon Beacon

판별할 비콘 객체

Return:

boolean

Region에 속하면 true, 아니면 false

public removeBeacons(beacons: *) source

Params:

NameTypeAttributeDescription
beacons *

public setBeacons(beacons: *): * source

Params:

NameTypeAttributeDescription
beacons *

Return:

*

public toString(): string source

Region의 식별자를 반환한다.

Return:

string

현재 Region의 id