Class LoggedInUser

Hierarchy (View Summary)

DataModelObject<UserID, ParsedDescartesSessionResponse>
- LoggedInUser

Index

Constructors

Properties

Methods

arePropertiesEditable arePropertiesSuggestible canEditDifficultTurns changeID clone decrementDeleteSegmentCount decrementSegmentStreetChangeCount didUserAgreeToTermsOfService getAddress getAttribute getAttributes getCreatedBy getCreatedOn getEditableArea getEmailAddress getHomeLocation getID getIsInBbox getLatestUserDriveSummary getMaxAllowedSegmentDeletions getMaxAllowedStreetNamesChanges getOnlineEditor getPermissions getPrevID getProfileImageURL getRank getSegmentDeletionCount getState getStreetNameChangeCount getSuggestionPermissions getType getUniqueID getUniqueIdentifier getUpdatedBy getUpdatedOn getUsername getVersion getVisibility getWorkLocation hasPermissionFlag hasProfileImageURL incrementDeleteSegmentCount incrementSegmentStreetChangeCount isAllowed isAllowedForSuggestion isCountryManager isDeleteable isDeleted isDeleteSuggestible isEmailAddressMissing isGeometryEditable isGeometrySuggestible isInserted isInUse isNew isOperatorUser isOutOfScope isPartnerUser isSelected isSnapped isUnchanged isUpdated isVerifiedEmail merge resetOutOfScope resetUserLimits setAttribute setAttributes setID setIsInBboxToTrue setOutOfScope setSelected setSnapped setState setVersion wasCreatedBy

Constructors

constructor

new LoggedInUser(
    attributes:
        | ObjectAttributes
        | Partial<
            {
                address?: Point;
                adOperator: boolean;
                areas: RawEditableArea[];
                chatBanned: boolean;
                debugUser: boolean;
                editableCountryIDs: number[];
                editableMiles: number;
                editingNotPermittedYet: boolean;
                email: string;
                emailAddress: string;
                emailVerified: boolean;
                globalEditor: boolean;
                hasAgreedTos: boolean;
                homeLocation?: Point;
                id: number;
                isAreaManager: boolean;
                isFirstLogin?: boolean;
                isStaff: boolean;
                latestUserDriveSummary?: RawLatestUserDriveSummary;
                managedAreas: ManagedAreaShort[];
                mapEditingBanned: boolean;
                maxAllowedSegmentDeletions?: number;
                maxAllowedStreetNamesChanges?: number;
                mteManager: boolean;
                onlineEditorDetails: RawOnlineEditor;
                operatorUser?: boolean;
                partnerUser?: boolean;
                permissions: number;
                profileImageUrl: string;
                rank: UserRank;
                savedIssueTrackerSearches: IndexedSavedSearches;
                totalEdits: number;
                totalForumPosts: number;
                totalPoints: number;
                unverifiedEmail?: string;
                userLimits: UserLimits;
                userName: string;
                workLocation?: Point;
            },
        >,
    permissions?: BasePermissions,
): LoggedInUser
Parameters
- attributes:
      | ObjectAttributes
      | Partial<
          {
              address?: Point;
              adOperator: boolean;
              areas: RawEditableArea[];
              chatBanned: boolean;
              debugUser: boolean;
              editableCountryIDs: number[];
              editableMiles: number;
              editingNotPermittedYet: boolean;
              email: string;
              emailAddress: string;
              emailVerified: boolean;
              globalEditor: boolean;
              hasAgreedTos: boolean;
              homeLocation?: Point;
              id: number;
              isAreaManager: boolean;
              isFirstLogin?: boolean;
              isStaff: boolean;
              latestUserDriveSummary?: RawLatestUserDriveSummary;
              managedAreas: ManagedAreaShort[];
              mapEditingBanned: boolean;
              maxAllowedSegmentDeletions?: number;
              maxAllowedStreetNamesChanges?: number;
              mteManager: boolean;
              onlineEditorDetails: RawOnlineEditor;
              operatorUser?: boolean;
              partnerUser?: boolean;
              permissions: number;
              profileImageUrl: string;
              rank: UserRank;
              savedIssueTrackerSearches: IndexedSavedSearches;
              totalEdits: number;
              totalForumPosts: number;
              totalPoints: number;
              unverifiedEmail?: string;
              userLimits: UserLimits;
              userName: string;
              workLocation?: Point;
          },
      >
- permissions: BasePermissions = {}
Returns LoggedInUser
Inherited from DataModelObject.constructor

Properties

`Static`ALL_PERMISSIONS

ALL_PERMISSIONS: number = 0x7fffffff

Methods

arePropertiesEditable

arePropertiesEditable(): boolean
Returns boolean
Inherited from DataModelObject.arePropertiesEditable

arePropertiesSuggestible

arePropertiesSuggestible(): boolean
Whether the current user can suggest a property change for the object

Returns boolean
Inherited from DataModelObject.arePropertiesSuggestible

canEditDifficultTurns

canEditDifficultTurns(): boolean
Returns boolean

changeID

changeID(newID: number): void
Parameters
- newID: number
Returns void
Inherited from DataModelObject.changeID

clone

clone(): LoggedInUser
Returns LoggedInUser
Inherited from DataModelObject.clone

decrementDeleteSegmentCount

decrementDeleteSegmentCount(): void
Returns void

decrementSegmentStreetChangeCount

decrementSegmentStreetChangeCount(): void
Returns void

didUserAgreeToTermsOfService

didUserAgreeToTermsOfService(): boolean
Returns boolean

getAddress

getAddress(): null | Point
Returns null | Point

getAttribute

getAttribute<
    TAttributeKey extends
        | "id"
        | "permissions"
        | "rank"
        | "address"
        | "homeLocation"
        | "isFirstLogin"
        | "latestUserDriveSummary"
        | "maxAllowedSegmentDeletions"
        | "maxAllowedStreetNamesChanges"
        | "unverifiedEmail"
        | "workLocation"
        | "managedAreas"
        | "areas"
        | "editingNotPermittedYet"
        | "editableMiles"
        | "emailAddress"
        | "onlineEditorDetails"
        | "profileImageUrl"
        | "savedIssueTrackerSearches"
        | "adOperator"
        | "chatBanned"
        | "debugUser"
        | "editableCountryIDs"
        | "email"
        | "emailVerified"
        | "globalEditor"
        | "hasAgreedTos"
        | "isAreaManager"
        | "isStaff"
        | "mapEditingBanned"
        | "mteManager"
        | "operatorUser"
        | "partnerUser"
        | "totalEdits"
        | "totalForumPosts"
        | "totalPoints"
        | "userLimits"
        | "userName",
>(
    key: TAttributeKey,
): {
    address?: Point;
    adOperator: boolean;
    areas: RawEditableArea[];
    chatBanned: boolean;
    debugUser: boolean;
    editableCountryIDs: number[];
    editableMiles: number;
    editingNotPermittedYet: boolean;
    email: string;
    emailAddress: string;
    emailVerified: boolean;
    globalEditor: boolean;
    hasAgreedTos: boolean;
    homeLocation?: Point;
    id: number;
    isAreaManager: boolean;
    isFirstLogin?: boolean;
    isStaff: boolean;
    latestUserDriveSummary?: RawLatestUserDriveSummary;
    managedAreas: ManagedAreaShort[];
    mapEditingBanned: boolean;
    maxAllowedSegmentDeletions?: number;
    maxAllowedStreetNamesChanges?: number;
    mteManager: boolean;
    onlineEditorDetails: RawOnlineEditor;
    operatorUser?: boolean;
    partnerUser?: boolean;
    permissions: number;
    profileImageUrl: string;
    rank: UserRank;
    savedIssueTrackerSearches: IndexedSavedSearches;
    totalEdits: number;
    totalForumPosts: number;
    totalPoints: number;
    unverifiedEmail?: string;
    userLimits: UserLimits;
    userName: string;
    workLocation?: Point;
}[TAttributeKey]
Type Parameters
- TAttributeKey extends
      | "id"
      | "permissions"
      | "rank"
      | "address"
      | "homeLocation"
      | "isFirstLogin"
      | "latestUserDriveSummary"
      | "maxAllowedSegmentDeletions"
      | "maxAllowedStreetNamesChanges"
      | "unverifiedEmail"
      | "workLocation"
      | "managedAreas"
      | "areas"
      | "editingNotPermittedYet"
      | "editableMiles"
      | "emailAddress"
      | "onlineEditorDetails"
      | "profileImageUrl"
      | "savedIssueTrackerSearches"
      | "adOperator"
      | "chatBanned"
      | "debugUser"
      | "editableCountryIDs"
      | "email"
      | "emailVerified"
      | "globalEditor"
      | "hasAgreedTos"
      | "isAreaManager"
      | "isStaff"
      | "mapEditingBanned"
      | "mteManager"
      | "operatorUser"
      | "partnerUser"
      | "totalEdits"
      | "totalForumPosts"
      | "totalPoints"
      | "userLimits"
      | "userName"
Parameters
- key: TAttributeKey
Returns {
    address?: Point;
    adOperator: boolean;
    areas: RawEditableArea[];
    chatBanned: boolean;
    debugUser: boolean;
    editableCountryIDs: number[];
    editableMiles: number;
    editingNotPermittedYet: boolean;
    email: string;
    emailAddress: string;
    emailVerified: boolean;
    globalEditor: boolean;
    hasAgreedTos: boolean;
    homeLocation?: Point;
    id: number;
    isAreaManager: boolean;
    isFirstLogin?: boolean;
    isStaff: boolean;
    latestUserDriveSummary?: RawLatestUserDriveSummary;
    managedAreas: ManagedAreaShort[];
    mapEditingBanned: boolean;
    maxAllowedSegmentDeletions?: number;
    maxAllowedStreetNamesChanges?: number;
    mteManager: boolean;
    onlineEditorDetails: RawOnlineEditor;
    operatorUser?: boolean;
    partnerUser?: boolean;
    permissions: number;
    profileImageUrl: string;
    rank: UserRank;
    savedIssueTrackerSearches: IndexedSavedSearches;
    totalEdits: number;
    totalForumPosts: number;
    totalPoints: number;
    unverifiedEmail?: string;
    userLimits: UserLimits;
    userName: string;
    workLocation?: Point;
}[TAttributeKey]
Inherited from DataModelObject.getAttribute

getAttributes

getAttributes(): {
    address?: Point;
    adOperator: boolean;
    areas: RawEditableArea[];
    chatBanned: boolean;
    debugUser: boolean;
    editableCountryIDs: number[];
    editableMiles: number;
    editingNotPermittedYet: boolean;
    email: string;
    emailAddress: string;
    emailVerified: boolean;
    globalEditor: boolean;
    hasAgreedTos: boolean;
    homeLocation?: Point;
    id: number;
    isAreaManager: boolean;
    isFirstLogin?: boolean;
    isStaff: boolean;
    latestUserDriveSummary?: RawLatestUserDriveSummary;
    managedAreas: ManagedAreaShort[];
    mapEditingBanned: boolean;
    maxAllowedSegmentDeletions?: number;
    maxAllowedStreetNamesChanges?: number;
    mteManager: boolean;
    onlineEditorDetails: RawOnlineEditor;
    operatorUser?: boolean;
    partnerUser?: boolean;
    permissions: number;
    profileImageUrl: string;
    rank: UserRank;
    savedIssueTrackerSearches: IndexedSavedSearches;
    totalEdits: number;
    totalForumPosts: number;
    totalPoints: number;
    unverifiedEmail?: string;
    userLimits: UserLimits;
    userName: string;
    workLocation?: Point;
}
Returns {
    address?: Point;
    adOperator: boolean;
    areas: RawEditableArea[];
    chatBanned: boolean;
    debugUser: boolean;
    editableCountryIDs: number[];
    editableMiles: number;
    editingNotPermittedYet: boolean;
    email: string;
    emailAddress: string;
    emailVerified: boolean;
    globalEditor: boolean;
    hasAgreedTos: boolean;
    homeLocation?: Point;
    id: number;
    isAreaManager: boolean;
    isFirstLogin?: boolean;
    isStaff: boolean;
    latestUserDriveSummary?: RawLatestUserDriveSummary;
    managedAreas: ManagedAreaShort[];
    mapEditingBanned: boolean;
    maxAllowedSegmentDeletions?: number;
    maxAllowedStreetNamesChanges?: number;
    mteManager: boolean;
    onlineEditorDetails: RawOnlineEditor;
    operatorUser?: boolean;
    partnerUser?: boolean;
    permissions: number;
    profileImageUrl: string;
    rank: UserRank;
    savedIssueTrackerSearches: IndexedSavedSearches;
    totalEdits: number;
    totalForumPosts: number;
    totalPoints: number;
    unverifiedEmail?: string;
    userLimits: UserLimits;
    userName: string;
    workLocation?: Point;
}
Inherited from DataModelObject.getAttributes

getCreatedBy

getCreatedBy(): undefined | null | number
Returns undefined | null | number
Inherited from DataModelObject.getCreatedBy

getCreatedOn

getCreatedOn(): undefined | null | number
Returns undefined | null | number
Inherited from DataModelObject.getCreatedOn

getEditableArea

getEditableArea(): null | Polygon
Returns null | Polygon

getEmailAddress

getEmailAddress(): string
Returns string

getHomeLocation

getHomeLocation(): null | Point
Returns null | Point

getID

getID(): number
Returns number
Inherited from DataModelObject.getID

getIsInBbox

getIsInBbox(): boolean
Returns boolean
Inherited from DataModelObject.getIsInBbox

getLatestUserDriveSummary

getLatestUserDriveSummary(): null | RawLatestUserDriveSummary
Returns null | RawLatestUserDriveSummary

getMaxAllowedSegmentDeletions

getMaxAllowedSegmentDeletions(): undefined | number
Returns undefined | number

getMaxAllowedStreetNamesChanges

getMaxAllowedStreetNamesChanges(): undefined | number
Returns undefined | number

getOnlineEditor

getOnlineEditor(): RawOnlineEditor
Returns RawOnlineEditor

getPermissions

getPermissions(): number
Returns number
Inherited from DataModelObject.getPermissions

getPrevID

getPrevID(): null | number
Returns null | number
Inherited from DataModelObject.getPrevID

getProfileImageURL

getProfileImageURL(): string
Returns string

getRank

getRank(): UserRank
Returns UserRank

getSegmentDeletionCount

getSegmentDeletionCount(): undefined | null | number
Returns undefined | null | number

getState

getState(): null | OBJECT_STATE
Returns null | OBJECT_STATE
Inherited from DataModelObject.getState

getStreetNameChangeCount

getStreetNameChangeCount(): undefined | null | number
Returns undefined | null | number

getSuggestionPermissions

getSuggestionPermissions(): number
Returns number
Inherited from DataModelObject.getSuggestionPermissions

getUpdatedBy

getUpdatedBy(): undefined | null | number
Returns undefined | null | number
Inherited from DataModelObject.getUpdatedBy

getUpdatedOn

getUpdatedOn(): undefined | null | number
Returns undefined | null | number
Inherited from DataModelObject.getUpdatedOn

getUsername

getUsername(): string
Returns string

getVersion

getVersion(): undefined | number
Returns undefined | number
Inherited from DataModelObject.getVersion

getVisibility

getVisibility(): boolean
Returns boolean

getWorkLocation

getWorkLocation(): null | Point
Returns null | Point

hasPermissionFlag

hasPermissionFlag(
    key:
        | "NO_PERMISSION"
        | "EDIT_GEOMETRY"
        | "EDIT_PROPERTIES"
        | "DELETE"
        | "EDIT_EMPTY_STREET"
        | "SPLIT_DIRECTIONS"
        | "SET_UNKNOWN_DIRECTIONS"
        | "EDIT_HOUSE_NUMBERS"
        | "FORCE_HOUSE_NUMBERS"
        | "EDIT_CONNECTIONS"
        | "EDIT_ROUTING_ROAD_TYPE"
        | "EDIT_CLOSURES"
        | "EDIT_HEADLIGHTS_REMINDER"
        | "EDIT_AVERAGE_SPEED_CAMERA"
        | "EDIT_BEACONS"
        | "EDIT_DIRECTIONS"
        | "EDIT_TURN_GUIDANCE"
        | "EDIT_OPEN_TURNS"
        | "EDIT_CLOSE_TURNS"
        | "EDIT"
        | "FORCE_CLOSE"
        | "PUBLISH"
        | "SET_READY"
        | "EDIT_UPDATE_REQUESTS"
        | "EDIT_EXTERNAL_PROVIDERS",
): boolean
Parameters
- key:
      | "NO_PERMISSION"
      | "EDIT_GEOMETRY"
      | "EDIT_PROPERTIES"
      | "DELETE"
      | "EDIT_EMPTY_STREET"
      | "SPLIT_DIRECTIONS"
      | "SET_UNKNOWN_DIRECTIONS"
      | "EDIT_HOUSE_NUMBERS"
      | "FORCE_HOUSE_NUMBERS"
      | "EDIT_CONNECTIONS"
      | "EDIT_ROUTING_ROAD_TYPE"
      | "EDIT_CLOSURES"
      | "EDIT_HEADLIGHTS_REMINDER"
      | "EDIT_AVERAGE_SPEED_CAMERA"
      | "EDIT_BEACONS"
      | "EDIT_DIRECTIONS"
      | "EDIT_TURN_GUIDANCE"
      | "EDIT_OPEN_TURNS"
      | "EDIT_CLOSE_TURNS"
      | "EDIT"
      | "FORCE_CLOSE"
      | "PUBLISH"
      | "SET_READY"
      | "EDIT_UPDATE_REQUESTS"
      | "EDIT_EXTERNAL_PROVIDERS"
Returns boolean
Inherited from DataModelObject.hasPermissionFlag

hasProfileImageURL

hasProfileImageURL(): boolean
Returns boolean

incrementDeleteSegmentCount

incrementDeleteSegmentCount(): void
Returns void

incrementSegmentStreetChangeCount

incrementSegmentStreetChangeCount(): void
Returns void

isAllowed

isAllowed(permission: number): boolean
Parameters
- permission: number
Returns boolean
Inherited from DataModelObject.isAllowed

isAllowedForSuggestion

isAllowedForSuggestion(suggestionPermission: number): boolean
Parameters
- suggestionPermission: number
Returns boolean
Inherited from DataModelObject.isAllowedForSuggestion

isCountryManager

isCountryManager(): boolean
Returns boolean

isDeleteable

isDeleteable(): boolean
Returns boolean
Inherited from DataModelObject.isDeleteable

isDeleted

isDeleted(): boolean
Returns boolean
Inherited from DataModelObject.isDeleted

isDeleteSuggestible

isDeleteSuggestible(): boolean
Returns boolean
Inherited from DataModelObject.isDeleteSuggestible

isEmailAddressMissing

isEmailAddressMissing(): boolean
Returns boolean

isGeometryEditable

isGeometryEditable(): boolean
Returns boolean
Inherited from DataModelObject.isGeometryEditable

isGeometrySuggestible

isGeometrySuggestible(): boolean
Whether the current user can suggest a geometry change for the object

Returns boolean
Inherited from DataModelObject.isGeometrySuggestible

isInserted

isInserted(): boolean
Returns boolean
Inherited from DataModelObject.isInserted

isInUse

isInUse(
options?: { keepSelected?: boolean; keepUnsaved?: boolean },
): undefined | boolean
Returns true if object is currently in use and should not be deleted.
Parameters
- options: { keepSelected?: boolean; keepUnsaved?: boolean } = ...
  See DataModelRepository.clear for available options
Returns undefined | boolean
true if object is in use

Inherited from DataModelObject.isInUse

isNew

isNew(): boolean
Returns boolean
Inherited from DataModelObject.isNew

isOperatorUser

isOperatorUser(): boolean
Returns boolean

isOutOfScope

isOutOfScope(): boolean
Returns boolean
Inherited from DataModelObject.isOutOfScope

isPartnerUser

isPartnerUser(): boolean
Returns boolean

isSelected

isSelected(): boolean
Returns boolean
Inherited from DataModelObject.isSelected

isSnapped

isSnapped(): boolean
Returns boolean
Inherited from DataModelObject.isSnapped

isUnchanged

isUnchanged(): boolean
Returns boolean
Inherited from DataModelObject.isUnchanged

isUpdated

isUpdated(): boolean
Returns boolean
Inherited from DataModelObject.isUpdated

isVerifiedEmail

isVerifiedEmail(): boolean
Returns boolean

merge

merge(
    attributes: Partial<
        {
            address?: Point;
            adOperator: boolean;
            areas: RawEditableArea[];
            chatBanned: boolean;
            debugUser: boolean;
            editableCountryIDs: number[];
            editableMiles: number;
            editingNotPermittedYet: boolean;
            email: string;
            emailAddress: string;
            emailVerified: boolean;
            globalEditor: boolean;
            hasAgreedTos: boolean;
            homeLocation?: Point;
            id: number;
            isAreaManager: boolean;
            isFirstLogin?: boolean;
            isStaff: boolean;
            latestUserDriveSummary?: RawLatestUserDriveSummary;
            managedAreas: ManagedAreaShort[];
            mapEditingBanned: boolean;
            maxAllowedSegmentDeletions?: number;
            maxAllowedStreetNamesChanges?: number;
            mteManager: boolean;
            onlineEditorDetails: RawOnlineEditor;
            operatorUser?: boolean;
            partnerUser?: boolean;
            permissions: number;
            profileImageUrl: string;
            rank: UserRank;
            savedIssueTrackerSearches: IndexedSavedSearches;
            totalEdits: number;
            totalForumPosts: number;
            totalPoints: number;
            unverifiedEmail?: string;
            userLimits: UserLimits;
            userName: string;
            workLocation?: Point;
        },
    >,
): void
Parameters
- attributes: Partial<
      {
          address?: Point;
          adOperator: boolean;
          areas: RawEditableArea[];
          chatBanned: boolean;
          debugUser: boolean;
          editableCountryIDs: number[];
          editableMiles: number;
          editingNotPermittedYet: boolean;
          email: string;
          emailAddress: string;
          emailVerified: boolean;
          globalEditor: boolean;
          hasAgreedTos: boolean;
          homeLocation?: Point;
          id: number;
          isAreaManager: boolean;
          isFirstLogin?: boolean;
          isStaff: boolean;
          latestUserDriveSummary?: RawLatestUserDriveSummary;
          managedAreas: ManagedAreaShort[];
          mapEditingBanned: boolean;
          maxAllowedSegmentDeletions?: number;
          maxAllowedStreetNamesChanges?: number;
          mteManager: boolean;
          onlineEditorDetails: RawOnlineEditor;
          operatorUser?: boolean;
          partnerUser?: boolean;
          permissions: number;
          profileImageUrl: string;
          rank: UserRank;
          savedIssueTrackerSearches: IndexedSavedSearches;
          totalEdits: number;
          totalForumPosts: number;
          totalPoints: number;
          unverifiedEmail?: string;
          userLimits: UserLimits;
          userName: string;
          workLocation?: Point;
      },
  >
Returns void
Inherited from DataModelObject.merge

resetOutOfScope

resetOutOfScope(): void
Returns void
Inherited from DataModelObject.resetOutOfScope

resetUserLimits

resetUserLimits(userLimits: UserLimits): void
Parameters
- userLimits: UserLimits
Returns void

setAttribute

setAttribute<
    TAttributeKey extends
        | "id"
        | "permissions"
        | "rank"
        | "address"
        | "homeLocation"
        | "isFirstLogin"
        | "latestUserDriveSummary"
        | "maxAllowedSegmentDeletions"
        | "maxAllowedStreetNamesChanges"
        | "unverifiedEmail"
        | "workLocation"
        | "managedAreas"
        | "areas"
        | "editingNotPermittedYet"
        | "editableMiles"
        | "emailAddress"
        | "onlineEditorDetails"
        | "profileImageUrl"
        | "savedIssueTrackerSearches"
        | "adOperator"
        | "chatBanned"
        | "debugUser"
        | "editableCountryIDs"
        | "email"
        | "emailVerified"
        | "globalEditor"
        | "hasAgreedTos"
        | "isAreaManager"
        | "isStaff"
        | "mapEditingBanned"
        | "mteManager"
        | "operatorUser"
        | "partnerUser"
        | "totalEdits"
        | "totalForumPosts"
        | "totalPoints"
        | "userLimits"
        | "userName",
>(
    key: TAttributeKey,
    value: {
        address?: Point;
        adOperator: boolean;
        areas: RawEditableArea[];
        chatBanned: boolean;
        debugUser: boolean;
        editableCountryIDs: number[];
        editableMiles: number;
        editingNotPermittedYet: boolean;
        email: string;
        emailAddress: string;
        emailVerified: boolean;
        globalEditor: boolean;
        hasAgreedTos: boolean;
        homeLocation?: Point;
        id: number;
        isAreaManager: boolean;
        isFirstLogin?: boolean;
        isStaff: boolean;
        latestUserDriveSummary?: RawLatestUserDriveSummary;
        managedAreas: ManagedAreaShort[];
        mapEditingBanned: boolean;
        maxAllowedSegmentDeletions?: number;
        maxAllowedStreetNamesChanges?: number;
        mteManager: boolean;
        onlineEditorDetails: RawOnlineEditor;
        operatorUser?: boolean;
        partnerUser?: boolean;
        permissions: number;
        profileImageUrl: string;
        rank: UserRank;
        savedIssueTrackerSearches: IndexedSavedSearches;
        totalEdits: number;
        totalForumPosts: number;
        totalPoints: number;
        unverifiedEmail?: string;
        userLimits: UserLimits;
        userName: string;
        workLocation?: Point;
    }[TAttributeKey],
): void
Type Parameters
- TAttributeKey extends
      | "id"
      | "permissions"
      | "rank"
      | "address"
      | "homeLocation"
      | "isFirstLogin"
      | "latestUserDriveSummary"
      | "maxAllowedSegmentDeletions"
      | "maxAllowedStreetNamesChanges"
      | "unverifiedEmail"
      | "workLocation"
      | "managedAreas"
      | "areas"
      | "editingNotPermittedYet"
      | "editableMiles"
      | "emailAddress"
      | "onlineEditorDetails"
      | "profileImageUrl"
      | "savedIssueTrackerSearches"
      | "adOperator"
      | "chatBanned"
      | "debugUser"
      | "editableCountryIDs"
      | "email"
      | "emailVerified"
      | "globalEditor"
      | "hasAgreedTos"
      | "isAreaManager"
      | "isStaff"
      | "mapEditingBanned"
      | "mteManager"
      | "operatorUser"
      | "partnerUser"
      | "totalEdits"
      | "totalForumPosts"
      | "totalPoints"
      | "userLimits"
      | "userName"
Parameters
- key: TAttributeKey
- value: {
      address?: Point;
      adOperator: boolean;
      areas: RawEditableArea[];
      chatBanned: boolean;
      debugUser: boolean;
      editableCountryIDs: number[];
      editableMiles: number;
      editingNotPermittedYet: boolean;
      email: string;
      emailAddress: string;
      emailVerified: boolean;
      globalEditor: boolean;
      hasAgreedTos: boolean;
      homeLocation?: Point;
      id: number;
      isAreaManager: boolean;
      isFirstLogin?: boolean;
      isStaff: boolean;
      latestUserDriveSummary?: RawLatestUserDriveSummary;
      managedAreas: ManagedAreaShort[];
      mapEditingBanned: boolean;
      maxAllowedSegmentDeletions?: number;
      maxAllowedStreetNamesChanges?: number;
      mteManager: boolean;
      onlineEditorDetails: RawOnlineEditor;
      operatorUser?: boolean;
      partnerUser?: boolean;
      permissions: number;
      profileImageUrl: string;
      rank: UserRank;
      savedIssueTrackerSearches: IndexedSavedSearches;
      totalEdits: number;
      totalForumPosts: number;
      totalPoints: number;
      unverifiedEmail?: string;
      userLimits: UserLimits;
      userName: string;
      workLocation?: Point;
  }[TAttributeKey]
Returns void
Inherited from DataModelObject.setAttribute

setAttributes

setAttributes(
    attributes: Partial<
        {
            address?: Point;
            adOperator: boolean;
            areas: RawEditableArea[];
            chatBanned: boolean;
            debugUser: boolean;
            editableCountryIDs: number[];
            editableMiles: number;
            editingNotPermittedYet: boolean;
            email: string;
            emailAddress: string;
            emailVerified: boolean;
            globalEditor: boolean;
            hasAgreedTos: boolean;
            homeLocation?: Point;
            id: number;
            isAreaManager: boolean;
            isFirstLogin?: boolean;
            isStaff: boolean;
            latestUserDriveSummary?: RawLatestUserDriveSummary;
            managedAreas: ManagedAreaShort[];
            mapEditingBanned: boolean;
            maxAllowedSegmentDeletions?: number;
            maxAllowedStreetNamesChanges?: number;
            mteManager: boolean;
            onlineEditorDetails: RawOnlineEditor;
            operatorUser?: boolean;
            partnerUser?: boolean;
            permissions: number;
            profileImageUrl: string;
            rank: UserRank;
            savedIssueTrackerSearches: IndexedSavedSearches;
            totalEdits: number;
            totalForumPosts: number;
            totalPoints: number;
            unverifiedEmail?: string;
            userLimits: UserLimits;
            userName: string;
            workLocation?: Point;
        },
    >,
): void
Parameters
- attributes: Partial<
      {
          address?: Point;
          adOperator: boolean;
          areas: RawEditableArea[];
          chatBanned: boolean;
          debugUser: boolean;
          editableCountryIDs: number[];
          editableMiles: number;
          editingNotPermittedYet: boolean;
          email: string;
          emailAddress: string;
          emailVerified: boolean;
          globalEditor: boolean;
          hasAgreedTos: boolean;
          homeLocation?: Point;
          id: number;
          isAreaManager: boolean;
          isFirstLogin?: boolean;
          isStaff: boolean;
          latestUserDriveSummary?: RawLatestUserDriveSummary;
          managedAreas: ManagedAreaShort[];
          mapEditingBanned: boolean;
          maxAllowedSegmentDeletions?: number;
          maxAllowedStreetNamesChanges?: number;
          mteManager: boolean;
          onlineEditorDetails: RawOnlineEditor;
          operatorUser?: boolean;
          partnerUser?: boolean;
          permissions: number;
          profileImageUrl: string;
          rank: UserRank;
          savedIssueTrackerSearches: IndexedSavedSearches;
          totalEdits: number;
          totalForumPosts: number;
          totalPoints: number;
          unverifiedEmail?: string;
          userLimits: UserLimits;
          userName: string;
          workLocation?: Point;
      },
  >
Returns void
Inherited from DataModelObject.setAttributes

setID

setID(id: number): void
Parameters
- id: number
Returns void
Inherited from DataModelObject.setID

setIsInBboxToTrue

setIsInBboxToTrue(): void
Returns void
Inherited from DataModelObject.setIsInBboxToTrue

setOutOfScope

setOutOfScope(): void
Returns void
Inherited from DataModelObject.setOutOfScope

setSelected

setSelected(isSelected: boolean): void
Parameters
- isSelected: boolean
Returns void
Inherited from DataModelObject.setSelected

setSnapped

setSnapped(isSnapped: boolean): void
Parameters
- isSnapped: boolean
Returns void
Inherited from DataModelObject.setSnapped

setState

setState(state: null | OBJECT_STATE): void
Parameters
- state: null | OBJECT_STATE
Returns void
Inherited from DataModelObject.setState

setVersion

setVersion(version: number): void
Parameters
- version: number
Returns void
Inherited from DataModelObject.setVersion

wasCreatedBy

wasCreatedBy(user: User | LoggedInUser): boolean
Parameters
- user: User | LoggedInUser
Returns boolean
Inherited from DataModelObject.wasCreatedBy

Class LoggedInUser

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LoggedInUser

Properties

StaticALL_PERMISSIONS

Methods

arePropertiesEditable

Returns boolean

arePropertiesSuggestible

Returns boolean

canEditDifficultTurns

Returns boolean

changeID

Parameters

Returns void

clone

Returns LoggedInUser

decrementDeleteSegmentCount

Returns void

decrementSegmentStreetChangeCount

Returns void

didUserAgreeToTermsOfService

Returns boolean

getAddress

Returns null | Point

getAttribute

Type Parameters

Parameters

getAttributes

getCreatedBy

Returns undefined | null | number

getCreatedOn

Returns undefined | null | number

getEditableArea

Returns null | Polygon

getEmailAddress

Returns string

getHomeLocation

Returns null | Point

getID

Returns number

getIsInBbox

Returns boolean

getLatestUserDriveSummary

Returns null | RawLatestUserDriveSummary

getMaxAllowedSegmentDeletions

Returns undefined | number

getMaxAllowedStreetNamesChanges

Returns undefined | number

getOnlineEditor

Returns RawOnlineEditor

getPermissions

Returns number

getPrevID

Returns null | number

getProfileImageURL

Returns string

getRank

Returns UserRank

getSegmentDeletionCount

Returns undefined | null | number

getState

Returns null | OBJECT_STATE

getStreetNameChangeCount

Returns undefined | null | number

getSuggestionPermissions

Returns number

getType

Returns DataModelObjectType

getUniqueID

Returns ObjectUniqueId

getUniqueIdentifier

Returns UniqueObjectIdentifier<number, DataModelObjectType>

`Static`ALL_PERMISSIONS