Gjsify LogoGjsify Logo

Hierarchy

  • DataBookCursorStepFunc

Callable

  • Method type for #EDataBookCursorClass.step()

    As all cursor methods may be called either by the addressbook service or directly by a client in Direct Read Access mode, it is important that the operation be an atomic transaction with the underlying database.

    The revision_guard, if specified, will be set to the %CLIENT_BACKEND_PROPERTY_REVISION value at the time which the given client issued the call to move the cursor. If the revision_guard provided by the client does not match the stored addressbook revision, then an %E_CLIENT_ERROR_OUT_OF_SYNC error should be set to indicate that the revision was out of sync while attempting to move the cursor.

    If the addressbook backend supports direct read access, then the revision comparison and reading of the data store must be coupled into a single atomic operation (the data read back from the store must be the correct data for the given addressbook revision).

    See e_data_book_cursor_step() for more details on the expected behaviour of this method.

    Parameters

    • cursor: DataBookCursor

      an #EDataBookCursor

    • revisionGuard: string

      The expected current addressbook revision, or %NULL

    • flags: BookCursorStepFlags

      The #EBookCursorStepFlags for this step

    • origin: BookCursorOrigin

      The #EBookCursorOrigin from whence to step

    • count: number

      a positive or negative amount of contacts to try and fetch

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method