EntityShareCronServiceInterface.php in Entity Share Cron 3.0.x

Namespace

Drupal\entity_share_cron

File

src/EntityShareCronServiceInterface.php

<?php

declare (strict_types=1);
namespace Drupal\entity_share_cron;


/**
 * Entity Share Cron service.
 */
interface EntityShareCronServiceInterface {
  const PENDING_QUEUE_NAME = 'entity_share_cron_pending';

  /**
   * Enqueues a channel for later synchronization.
   *
   * @param string $remote_id
   *   The ID of the remote the channel belongs to.
   * @param string $channel_id
   *   The ID of the channel to be enqueued.
   * @param null|string $url
   *   The url of the page to enqueue for import. NULL if starting from the
   *   first page.
   */
  public function enqueue($remote_id, $channel_id, $url);

  /**
   * Synchronizes entities starting from provided channel.
   *
   * @param string $remote_id
   *   The ID of the remote the channel belongs to.
   * @param string $channel_id
   *   The ID of the channel to be synchronized.
   * @param null|string $url
   *   The url of the page to enqueue for import. NULL if starting from the
   *   first page.
   */
  public function sync($remote_id, $channel_id, $url);

}

Interfaces

Name	Description
EntityShareCronServiceInterface	Entity Share Cron service.