Skip to content

Commit

Permalink
add - doc - Added support for three key types in Android
Browse files Browse the repository at this point in the history 
We've added support for three new key types in Android contacts parser

---

In the Android contacts parser, we've added support for the following keys:
  - vnd.android.cursor.item/relation: Specifies the contact relation
  - vnd.android.cursor.item/contact_event: Specifies the contact event
  - vnd.android.cursor.item/identity: Specifies the contact identity

---

Type: add
Breaking: False
Doc Required: True
Part: 1/1
  • Loading branch information
@AptiviCEO
AptiviCEO committed Oct 1, 2023
1 parent 35ec7b0 commit 4f0cea9
Showing 1 changed file with 71 additions and 14 deletions.
85 changes: 71 additions & 14 deletions VisualCard/Converters/AndroidContactsDb.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ ORDER BY
"""
);
bool idChanged = false;
bool birthdaySeen = false;
string lastId = "";
while (reader.Read())
{
Expand Down Expand Up @@ -170,7 +171,6 @@ ORDER BY
// so we have to figure things out.
switch (mtype)
{
// HACK: Not a complete list of vnd.android.cursor.item/* for contacts, so things may appear incomplete.
case "vnd.android.cursor.item/name":
// Example:
//
Expand Down Expand Up @@ -209,7 +209,7 @@ ORDER BY
{
// Let's do some translation work!
// From Android's source code:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/provider/ContactsContract.java;l=6297
// https://cs.android.com/android/platform/superproject/+/main:frameworks/base/core/java/android/provider/ContactsContract.java;l=6297
//
// public static final int TYPE_HOME = 1;
// public static final int TYPE_MOBILE = 2;
Expand All @@ -233,7 +233,7 @@ ORDER BY
// public static final int TYPE_MMS = 20;
//
// Translation to VCard code is found here:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1589
// https://cs.android.com/android/platform/superproject/+/main:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1589
case "1":
// TYPE_HOME -> home
_telephoneTypeName = "home";
Expand Down Expand Up @@ -322,15 +322,15 @@ ORDER BY
{
// Let's do some translation work!
// From Android's source code:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/provider/ContactsContract.java;l=6582
// https://cs.android.com/android/platform/superproject/+/main:frameworks/base/core/java/android/provider/ContactsContract.java;l=6582
//
// public static final int TYPE_HOME = 1;
// public static final int TYPE_WORK = 2;
// public static final int TYPE_OTHER = 3;
// public static final int TYPE_MOBILE = 4;
//
// Translation to VCard code is found here:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1526
// https://cs.android.com/android/platform/superproject/+/main:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1526
case "2":
// TYPE_WORK -> work
_emailTypeName = "work";
Expand Down Expand Up @@ -367,14 +367,14 @@ ORDER BY
{
// Let's do some translation work!
// From Android's source code:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/provider/ContactsContract.java;l=6733
// https://cs.android.com/android/platform/superproject/+/main:frameworks/base/core/java/android/provider/ContactsContract.java;l=6733
//
// public static final int TYPE_HOME = 1;
// public static final int TYPE_WORK = 2;
// public static final int TYPE_OTHER = 3;
//
// Translation to VCard code is found here:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1444
// https://cs.android.com/android/platform/superproject/+/main:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1444
case "2":
// TYPE_WORK -> work
_addressTypeName = "work";
Expand Down Expand Up @@ -407,14 +407,14 @@ ORDER BY
{
// Let's do some translation work!
// From Android's source code:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/provider/ContactsContract.java;l=6900
// https://cs.android.com/android/platform/superproject/+/main:frameworks/base/core/java/android/provider/ContactsContract.java;l=6900
//
// public static final int TYPE_HOME = 1;
// public static final int TYPE_WORK = 2;
// public static final int TYPE_OTHER = 3;
//
// Translation to VCard code is found here:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1178
// https://cs.android.com/android/platform/superproject/+/main:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1178
case "2":
// TYPE_WORK -> work
_imTypeName = "work";
Expand All @@ -439,7 +439,7 @@ ORDER BY
// public static final String PROPERTY_X_QQ = "X-QQ";
// public static final String PROPERTY_X_NETMEETING = "X-NETMEETING";
//
// Taken from: https://cs.android.com/android/platform/superproject/+/master:frameworks/opt/vcard/java/com/android/vcard/VCardConstants.java;l=78
// Taken from: https://cs.android.com/android/platform/superproject/+/main:frameworks/opt/vcard/java/com/android/vcard/VCardConstants.java;l=78
case "1":
// PROPERTY_X_MSN => X-MSN
_imSpecifier = "X-MSN";
Expand Down Expand Up @@ -493,13 +493,13 @@ ORDER BY
{
// Let's do some translation work!
// From Android's source code:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/provider/ContactsContract.java;l=7120
// https://cs.android.com/android/platform/superproject/+/main:frameworks/base/core/java/android/provider/ContactsContract.java;l=7120
//
// public static final int TYPE_WORK = 1;
// public static final int TYPE_OTHER = 2;
//
// Translation to VCard code is found here:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1178
// https://cs.android.com/android/platform/superproject/+/main:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1178
case "2":
// TYPE_OTHER -> x-other
_orgTypeName = "x-other";
Expand Down Expand Up @@ -536,14 +536,14 @@ ORDER BY
{
// Let's do some translation work!
// From Android's source code:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/provider/ContactsContract.java;l=7711
// https://cs.android.com/android/platform/superproject/+/main:frameworks/base/core/java/android/provider/ContactsContract.java;l=7711
//
// public static final int TYPE_HOME = 1;
// public static final int TYPE_WORK = 2;
// public static final int TYPE_OTHER = 3;
//
// Translation to VCard code is found here:
// https://cs.android.com/android/platform/superproject/+/master:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1782
// https://cs.android.com/android/platform/superproject/+/main:frameworks/opt/vcard/java/com/android/vcard/VCardBuilder.java;l=1782
case "2":
// TYPE_WORK -> work
_imppTypeName = "work";
Expand All @@ -555,6 +555,63 @@ ORDER BY
}
masterContactBuilder.AppendLine($"{_imppSpecifierWithType}TYPE={_imppTypeName}:sip:{d1}");
break;
case "vnd.android.cursor.item/relation":
// Example:
//
// _id mimetype data1 data2
// 7 vnd.android.cursor.item/relation Name 2
//
// | d1: Relative name
// | d2: Relative type
// ---> will get converted to VCard line:
// X-ANDROID-CUSTOM:vnd.android.cursor.item/relation;Name;2;;;;;;;;;;;;;
const string _relativeSpecifierWithType = "X-ANDROID-CUSTOM:vnd.android.cursor.item/relation;";
masterContactBuilder.AppendLine($"{_relativeSpecifierWithType}{d1};{d2};;;;;;;;;;;;;");
break;
case "vnd.android.cursor.item/contact_event":
// Example:
//
// _id mimetype data1 data2
// 7 vnd.android.cursor.item/contact_event 07/21/1993 1
//
// | d1: Event date
// | d2: Event type
// ---> will get converted to VCard line for birthday events:
// BDAY:07/21/1993
// ---> will get converted to VCard line for other events:
// X-ANDROID-CUSTOM:vnd.android.cursor.item/contact_event;07/21/1993;1;;;;;;;;;;;;;
const string _contactEventSpecifierWithType = "X-ANDROID-CUSTOM:vnd.android.cursor.item/contact_event;";
const string _contactEventBirthdaySpecifierWithType = "BDAY:";

// According to the translation done below, these are supported:
//
// public static final int TYPE_ANNIVERSARY = 1;
// public static final int TYPE_OTHER = 2;
// public static final int TYPE_BIRTHDAY = 3;
//
// Taken from https://cs.android.com/android/platform/superproject/+/main:frameworks/base/core/java/android/provider/ContactsContract.java;l=7379
if (d2 == "3" && !birthdaySeen)
{
// This event is a birthday, so we need not to add more than one.
birthdaySeen = true;
masterContactBuilder.AppendLine($"{_contactEventBirthdaySpecifierWithType}{d1}");
}
else
masterContactBuilder.AppendLine($"{_contactEventSpecifierWithType}{d1};{d2};;;;;;;;;;;;;");
break;
case "vnd.android.cursor.item/identity":
// Example:
//
// _id mimetype data1 data2
// 7 vnd.android.cursor.item/identity myid com.aptivi
//
// | d1: Identity
// | d2: Identity namespace
// ---> will get converted to VCard line:
// X-ANDROID-CUSTOM:vnd.android.cursor.item/identity;myid;com.aptivi;;;;;;;;;;;;;
const string _identitySpecifierWithType = "X-ANDROID-CUSTOM:vnd.android.cursor.item/identity;";
masterContactBuilder.AppendLine($"{_identitySpecifierWithType}{d1};{d2};;;;;;;;;;;;;");
break;
case "vnd.android.cursor.item/note":
// Example:
//
Expand Down

0 comments on commit 4f0cea9

Please sign in to comment.