Class AddressInfo

Address info class

Hierarchy

GemAutoreleaseObject
- AddressInfo

Index

Constructors

Accessors

mapId pointerId

Methods

equals format getField hashCode registerAutoReleaseObject setField toJson create fromJson

Constructors

constructor

new AddressInfo(id: number, mapId: number): AddressInfo
Internal
Internal constructor.
Parameters
- id: number
  Native pointer id
- mapId: number
  Map id
Returns AddressInfo
Overrides GemAutoreleaseObject.constructor
- Defined in core/addressinfo.ts:188

Accessors

mapId

get mapId(): number
Returns number
- Defined in core/addressinfo.ts:168

pointerId

get pointerId(): number
Returns number
- Defined in core/addressinfo.ts:167

Methods

equals

equals(other: AddressInfo): boolean
Checks equality with another AddressInfo instance.
Parameters
- other: AddressInfo
  The other AddressInfo instance
Returns boolean
True if equal, false otherwise
- Defined in core/addressinfo.ts:261

format

format(
    options: {
        excludeFields?: AddressField[];
        includeFields?: AddressField[];
    },
): string
Formats the address as a string.
Parameters
- options: { excludeFields?: AddressField[]; includeFields?: AddressField[] }
  Object containing the following fields:
  - OptionalexcludeFields?: AddressField[]
    Fields to exclude from result
  - OptionalincludeFields?: AddressField[]
    Fields to include in result
Returns string
Formatted address string
- Defined in core/addressinfo.ts:202

getField

getField(field: AddressField): string | null
Gets address field value.
Parameters
- field: AddressField
  The address field to get
Returns string | null
Field value or null if not exists
- Defined in core/addressinfo.ts:229

hashCode

hashCode(): number
Computes a hash code for the address info.

Returns number
Hash code
- Defined in core/addressinfo.ts:280

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:14

setField

setField(str: string, field: AddressField): void
Sets address field value.
Parameters
- str: string
  The new value
- field: AddressField
  The address field to set
Returns void
- Defined in core/addressinfo.ts:247

toJson

toJson(): Record<string, string>
Converts this AddressInfo to a JSON object.

Returns Record<string, string>
JSON object with string keys and values
- Defined in core/addressinfo.ts:325

`Static`create

create(): AddressInfo
Creates a new AddressInfo instance.

Returns AddressInfo
New AddressInfo instance
- Defined in core/addressinfo.ts:174

`Static`fromJson

fromJson(json: Record<string, string>): AddressInfo
Creates AddressInfo from JSON
Parameters
- json: Record<string, string>
  The JSON object
Returns AddressInfo
New AddressInfo instance
- Defined in core/addressinfo.ts:343