Added in API level 21

PinnedPositions

class PinnedPositions
kotlin.Any
   ↳ android.provider.ContactsContract.PinnedPositions

Contact-specific information about whether or not a contact has been pinned by the user at a particular position within the system contact application's user interface.

This pinning information can be used by individual applications to customize how they order particular pinned contacts. For example, a Dialer application could use pinned information to order user-pinned contacts in a top row of favorites.

It is possible for two or more contacts to occupy the same pinned position (due to aggregation and sync), so this pinning information should be used on a best-effort basis to order contacts in-application rather than an absolute guide on where a contact should be positioned. Contacts returned by the ContactsProvider will not be ordered based on this information, so it is up to the client application to reorder these contacts within their own UI adhering to (or ignoring as appropriate) information stored in the pinned column.

By default, unpinned contacts will have a pinned position of PinnedPositions#UNPINNED. Client-provided pinned positions can be positive integers that are greater than 1.

Summary

Constants
static Int

Value of pinned position for a contact that a user has indicated should be considered of the lowest priority.
static Int

Default value for the pinned position of an unpinned contact.
Public constructors

Public methods
static Unit
pin(contentResolver: ContentResolver!, contactId: Long, pinnedPosition: Int)

Pins a contact at a provided position, or unpins a contact.
static Unit
undemote(contentResolver: ContentResolver!, contactId: Long)

Undemotes a formerly demoted contact.

Constants

DEMOTED

Added in API level 21
static val DEMOTED: Int

Value of pinned position for a contact that a user has indicated should be considered of the lowest priority. It is up to the client application to determine how to present such a contact - for example all the way at the bottom of a contact list, or simply just hidden from view.

Value: -1

UNPINNED

Added in API level 21
static val UNPINNED: Int

Default value for the pinned position of an unpinned contact.

Value: 0

Public constructors

PinnedPositions

PinnedPositions()

Public methods

pin

Added in API level 21
static fun pin(
    contentResolver: ContentResolver!, 
    contactId: Long, 
    pinnedPosition: Int
): Unit

Pins a contact at a provided position, or unpins a contact.

Parameters
contentResolver ContentResolver!: to perform the pinning operation on.
pinnedPosition Int: the position to pin the contact at. To unpin a contact, use PinnedPositions#UNPINNED.

undemote

Added in API level 21
static fun undemote(
    contentResolver: ContentResolver!, 
    contactId: Long
): Unit

Undemotes a formerly demoted contact. If the contact was not previously demoted, nothing will be done.

Parameters
contentResolver ContentResolver!: to perform the undemote operation on.
contactId Long: the id of the contact to undemote.