Added in API level 5

SyncAdapterType


open class SyncAdapterType : Parcelable
kotlin.Any
   ↳ android.content.SyncAdapterType

Value type that represents a SyncAdapterType. This object overrides equals and hashCode, making it suitable for use as the key of a java.util.Map

Summary

Inherited constants
Public constructors

SyncAdapterType(authority: String!, accountType: String!, userVisible: Boolean, supportsUploading: Boolean)

Public methods
open Boolean

open Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

open String!

open Int

Returns a hash code value for the object.

open Boolean

If true then the SyncManager will never issue an initialization sync to the SyncAdapter and will instead automatically call ContentResolver.setIsSyncable(android.accounts.Account, String, int) with a value of 1 for each account and provider that this sync adapter supports.

open Boolean

open static SyncAdapterType!
newKey(authority: String!, accountType: String!)

open Boolean

open String

Returns a string representation of the object.

open Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<SyncAdapterType!>

String!

String!

Boolean

Public constructors

SyncAdapterType

Added in API level 5
SyncAdapterType(source: Parcel!)

SyncAdapterType

Added in API level 5
SyncAdapterType(
    authority: String!,
    accountType: String!,
    userVisible: Boolean,
    supportsUploading: Boolean)

Public methods

allowParallelSyncs

Added in API level 11
open fun allowParallelSyncs(): Boolean
Return
Boolean True if this SyncAdapter supports syncing multiple accounts simultaneously. If false then the SyncManager will take care to only start one sync at a time using this SyncAdapter.

describeContents

Added in API level 5
open fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 5
open fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getSettingsActivity

Added in API level 14
open fun getSettingsActivity(): String!
Return
String! The activity to use to invoke this SyncAdapter's settings activity. May be null.

hashCode

Added in API level 5
open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

isAlwaysSyncable

Added in API level 11
open fun isAlwaysSyncable(): Boolean

If true then the SyncManager will never issue an initialization sync to the SyncAdapter and will instead automatically call ContentResolver.setIsSyncable(android.accounts.Account, String, int) with a value of 1 for each account and provider that this sync adapter supports.

Return
Boolean true if the SyncAdapter does not require initialization and if it is ok for the SyncAdapter to treat it as syncable automatically.

isUserVisible

Added in API level 5
open fun isUserVisible(): Boolean

newKey

Added in API level 5
open static fun newKey(
    authority: String!,
    accountType: String!
): SyncAdapterType!

supportsUploading

Added in API level 5
open fun supportsUploading(): Boolean

toString

Added in API level 5
open fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 5
open fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 5
static val CREATOR: Parcelable.Creator<SyncAdapterType!>

accountType

Added in API level 5
val accountType: String!

authority

Added in API level 5
val authority: String!

isKey

Added in API level 5
val isKey: Boolean