UserInfo - SK docs

UserInfo.json

{
  "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift" : {
    "key.diagnostic_stage" : "source.diagnostic.stage.swift.parse",
    "key.length" : 999,
    "key.offset" : 0,
    "key.substructure" : [
      {
        "key.accessibility" : "source.lang.swift.accessibility.internal",
        "key.annotated_decl" : "<Declaration>internal class UserInfoProvider<\/Declaration>",
        "key.attributes" : [
          {
            "key.attribute" : "source.decl.attribute.internal",
            "key.length" : 8,
            "key.offset" : 298
          }
        ],
        "key.bodylength" : 539,
        "key.bodyoffset" : 331,
        "key.doc.column" : 16,
        "key.doc.comment" : "Shared user info provider.",
        "key.doc.declaration" : "internal class UserInfoProvider",
        "key.doc.file" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
        "key.doc.full_as_xml" : "<Class file=\"\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift\" line=\"10\" column=\"16\"><Name>UserInfoProvider<\/Name><USR>s:7Datadog16UserInfoProviderC<\/USR><Declaration>internal class UserInfoProvider<\/Declaration><CommentParts><Abstract><Para>Shared user info provider.<\/Para><\/Abstract><\/CommentParts><\/Class>",
        "key.doc.line" : 10,
        "key.doc.name" : "UserInfoProvider",
        "key.doc.type" : "Class",
        "key.doclength" : 31,
        "key.docoffset" : 267,
        "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
        "key.fully_annotated_decl" : "<decl.class><syntaxtype.keyword>internal<\/syntaxtype.keyword> <syntaxtype.keyword>class<\/syntaxtype.keyword> <decl.name>UserInfoProvider<\/decl.name><\/decl.class>",
        "key.kind" : "source.lang.swift.decl.class",
        "key.length" : 564,
        "key.name" : "UserInfoProvider",
        "key.namelength" : 16,
        "key.nameoffset" : 313,
        "key.offset" : 307,
        "key.parsed_declaration" : "internal class UserInfoProvider",
        "key.parsed_scope.end" : 21,
        "key.parsed_scope.start" : 10,
        "key.runtime_name" : "_TtC4main16UserInfoProvider",
        "key.substructure" : [
          {
            "key.accessibility" : "source.lang.swift.accessibility.private",
            "key.annotated_decl" : "<Declaration>private let queue: <Type usr=\"c:objc(cs)OS_dispatch_queue\">DispatchQueue<\/Type><\/Declaration>",
            "key.attributes" : [
              {
                "key.attribute" : "source.decl.attribute.private",
                "key.length" : 7,
                "key.offset" : 570
              }
            ],
            "key.doc.column" : 17,
            "key.doc.comment" : "Ensures thread-safe access to `UserInfo`.\n`UserInfo` can be mutated by any user thread with `Datadog.setUserInfo(id:name:email:)` - at the same\ntime it might be accessed by different queues running in the SDK.",
            "key.doc.declaration" : "private let queue: DispatchQueue",
            "key.doc.file" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
            "key.doc.full_as_xml" : "<Other file=\"\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift\" line=\"14\" column=\"17\"><Name>queue<\/Name><USR>s:7Datadog16UserInfoProviderC5queue33_ADB389E24071733235CA67A4BA34B026LLSo012OS_dispatch_E0Cvp<\/USR><Declaration>private let queue: DispatchQueue<\/Declaration><CommentParts><Abstract><Para>Ensures thread-safe access to <codeVoice>UserInfo<\/codeVoice>. <codeVoice>UserInfo<\/codeVoice> can be mutated by any user thread with <codeVoice>Datadog.setUserInfo(id:name:email:)<\/codeVoice> - at the same time it might be accessed by different queues running in the SDK.<\/Para><\/Abstract><\/CommentParts><\/Other>",
            "key.doc.line" : 14,
            "key.doc.name" : "queue",
            "key.doc.type" : "Other",
            "key.doclength" : 230,
            "key.docoffset" : 336,
            "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
            "key.fully_annotated_decl" : "<decl.var.instance><syntaxtype.keyword>private<\/syntaxtype.keyword> <syntaxtype.keyword>let<\/syntaxtype.keyword> <decl.name>queue<\/decl.name>: <decl.var.type><ref.class usr=\"c:objc(cs)OS_dispatch_queue\">DispatchQueue<\/ref.class><\/decl.var.type><\/decl.var.instance>",
            "key.kind" : "source.lang.swift.decl.var.instance",
            "key.length" : 91,
            "key.name" : "queue",
            "key.namelength" : 5,
            "key.nameoffset" : 582,
            "key.offset" : 578,
            "key.parsed_declaration" : "private let queue = DispatchQueue(label: \"com.datadoghq.user-info-provider\", qos: .userInteractive)",
            "key.parsed_scope.end" : 14,
            "key.parsed_scope.start" : 14,
            "key.typename" : "DispatchQueue",
            "key.typeusr" : "$sSo17OS_dispatch_queueCD",
            "key.usr" : "s:7Datadog16UserInfoProviderC5queue33_ADB389E24071733235CA67A4BA34B026LLSo012OS_dispatch_E0Cvp"
          },
          {
            "key.accessibility" : "source.lang.swift.accessibility.private",
            "key.annotated_decl" : "<Declaration>private var current: <Type usr=\"s:7Datadog8UserInfoV\">UserInfo<\/Type><\/Declaration>",
            "key.attributes" : [
              {
                "key.attribute" : "source.decl.attribute.private",
                "key.length" : 7,
                "key.offset" : 674
              }
            ],
            "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
            "key.fully_annotated_decl" : "<decl.var.instance><syntaxtype.keyword>private<\/syntaxtype.keyword> <syntaxtype.keyword>var<\/syntaxtype.keyword> <decl.name>current<\/decl.name>: <decl.var.type><ref.struct usr=\"s:7Datadog8UserInfoV\">UserInfo<\/ref.struct><\/decl.var.type><\/decl.var.instance>",
            "key.kind" : "source.lang.swift.decl.var.instance",
            "key.length" : 54,
            "key.name" : "current",
            "key.namelength" : 7,
            "key.nameoffset" : 686,
            "key.offset" : 682,
            "key.parsed_declaration" : "private var current = UserInfo(id: nil, name: nil, email: nil)",
            "key.parsed_scope.end" : 15,
            "key.parsed_scope.start" : 15,
            "key.setter_accessibility" : "source.lang.swift.accessibility.private",
            "key.typename" : "UserInfo",
            "key.typeusr" : "$s7Datadog8UserInfoVD",
            "key.usr" : "s:7Datadog16UserInfoProviderC7current33_ADB389E24071733235CA67A4BA34B026LLAA0bC0Vvp"
          },
          {
            "key.accessibility" : "source.lang.swift.accessibility.internal",
            "key.annotated_decl" : "<Declaration>var value: <Type usr=\"s:7Datadog8UserInfoV\">UserInfo<\/Type> { get set }<\/Declaration>",
            "key.bodylength" : 105,
            "key.bodyoffset" : 763,
            "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
            "key.fully_annotated_decl" : "<decl.var.instance><syntaxtype.keyword>var<\/syntaxtype.keyword> <decl.name>value<\/decl.name>: <decl.var.type><ref.struct usr=\"s:7Datadog8UserInfoV\">UserInfo<\/ref.struct><\/decl.var.type> { <syntaxtype.keyword>get<\/syntaxtype.keyword> <syntaxtype.keyword>set<\/syntaxtype.keyword> }<\/decl.var.instance>",
            "key.kind" : "source.lang.swift.decl.var.instance",
            "key.length" : 127,
            "key.name" : "value",
            "key.namelength" : 5,
            "key.nameoffset" : 746,
            "key.offset" : 742,
            "key.parsed_declaration" : "var value: UserInfo",
            "key.parsed_scope.end" : 20,
            "key.parsed_scope.start" : 17,
            "key.setter_accessibility" : "source.lang.swift.accessibility.internal",
            "key.typename" : "UserInfo",
            "key.typeusr" : "$s7Datadog8UserInfoVD",
            "key.usr" : "s:7Datadog16UserInfoProviderC5valueAA0bC0Vvp"
          }
        ],
        "key.typename" : "UserInfoProvider.Type",
        "key.typeusr" : "$s7Datadog16UserInfoProviderCmD",
        "key.usr" : "s:7Datadog16UserInfoProviderC"
      },
      {
        "key.accessibility" : "source.lang.swift.accessibility.internal",
        "key.annotated_decl" : "<Declaration>internal struct UserInfo<\/Declaration>",
        "key.attributes" : [
          {
            "key.attribute" : "source.decl.attribute.internal",
            "key.length" : 8,
            "key.offset" : 905
          }
        ],
        "key.bodylength" : 66,
        "key.bodyoffset" : 931,
        "key.doc.column" : 17,
        "key.doc.comment" : "Information about the user.",
        "key.doc.declaration" : "internal struct UserInfo",
        "key.doc.file" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
        "key.doc.full_as_xml" : "<Class file=\"\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift\" line=\"24\" column=\"17\"><Name>UserInfo<\/Name><USR>s:7Datadog8UserInfoV<\/USR><Declaration>internal struct UserInfo<\/Declaration><CommentParts><Abstract><Para>Information about the user.<\/Para><\/Abstract><\/CommentParts><\/Class>",
        "key.doc.line" : 24,
        "key.doc.name" : "UserInfo",
        "key.doc.type" : "Class",
        "key.doclength" : 32,
        "key.docoffset" : 873,
        "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
        "key.fully_annotated_decl" : "<decl.struct><syntaxtype.keyword>internal<\/syntaxtype.keyword> <syntaxtype.keyword>struct<\/syntaxtype.keyword> <decl.name>UserInfo<\/decl.name><\/decl.struct>",
        "key.kind" : "source.lang.swift.decl.struct",
        "key.length" : 84,
        "key.name" : "UserInfo",
        "key.namelength" : 8,
        "key.nameoffset" : 921,
        "key.offset" : 914,
        "key.parsed_declaration" : "internal struct UserInfo",
        "key.parsed_scope.end" : 28,
        "key.parsed_scope.start" : 24,
        "key.substructure" : [
          {
            "key.accessibility" : "source.lang.swift.accessibility.internal",
            "key.annotated_decl" : "<Declaration>let id: <Type usr=\"s:SS\">String<\/Type>?<\/Declaration>",
            "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
            "key.fully_annotated_decl" : "<decl.var.instance><syntaxtype.keyword>let<\/syntaxtype.keyword> <decl.name>id<\/decl.name>: <decl.var.type><ref.struct usr=\"s:SS\">String<\/ref.struct>?<\/decl.var.type><\/decl.var.instance>",
            "key.kind" : "source.lang.swift.decl.var.instance",
            "key.length" : 15,
            "key.name" : "id",
            "key.namelength" : 2,
            "key.nameoffset" : 940,
            "key.offset" : 936,
            "key.parsed_declaration" : "let id: String?",
            "key.parsed_scope.end" : 25,
            "key.parsed_scope.start" : 25,
            "key.typename" : "String?",
            "key.typeusr" : "$sSSSgD",
            "key.usr" : "s:7Datadog8UserInfoV2idSSSgvp"
          },
          {
            "key.accessibility" : "source.lang.swift.accessibility.internal",
            "key.annotated_decl" : "<Declaration>let name: <Type usr=\"s:SS\">String<\/Type>?<\/Declaration>",
            "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
            "key.fully_annotated_decl" : "<decl.var.instance><syntaxtype.keyword>let<\/syntaxtype.keyword> <decl.name>name<\/decl.name>: <decl.var.type><ref.struct usr=\"s:SS\">String<\/ref.struct>?<\/decl.var.type><\/decl.var.instance>",
            "key.kind" : "source.lang.swift.decl.var.instance",
            "key.length" : 17,
            "key.name" : "name",
            "key.namelength" : 4,
            "key.nameoffset" : 960,
            "key.offset" : 956,
            "key.parsed_declaration" : "let name: String?",
            "key.parsed_scope.end" : 26,
            "key.parsed_scope.start" : 26,
            "key.typename" : "String?",
            "key.typeusr" : "$sSSSgD",
            "key.usr" : "s:7Datadog8UserInfoV4nameSSSgvp"
          },
          {
            "key.accessibility" : "source.lang.swift.accessibility.internal",
            "key.annotated_decl" : "<Declaration>let email: <Type usr=\"s:SS\">String<\/Type>?<\/Declaration>",
            "key.filepath" : "\/Users\/maciek.grzybowski\/Products\/dd-sdk-ios\/Sources\/Datadog\/Core\/Attributes\/UserInfo.swift",
            "key.fully_annotated_decl" : "<decl.var.instance><syntaxtype.keyword>let<\/syntaxtype.keyword> <decl.name>email<\/decl.name>: <decl.var.type><ref.struct usr=\"s:SS\">String<\/ref.struct>?<\/decl.var.type><\/decl.var.instance>",
            "key.kind" : "source.lang.swift.decl.var.instance",
            "key.length" : 18,
            "key.name" : "email",
            "key.namelength" : 5,
            "key.nameoffset" : 982,
            "key.offset" : 978,
            "key.parsed_declaration" : "let email: String?",
            "key.parsed_scope.end" : 27,
            "key.parsed_scope.start" : 27,
            "key.typename" : "String?",
            "key.typeusr" : "$sSSSgD",
            "key.usr" : "s:7Datadog8UserInfoV5emailSSSgvp"
          }
        ],
        "key.typename" : "UserInfo.Type",
        "key.typeusr" : "$s7Datadog8UserInfoVmD",
        "key.usr" : "s:7Datadog8UserInfoV"
      }
    ]
  }
}