TwitterProfileInterface.php in Twitter Profile Widget 8

Namespace

Drupal\twitter_profile_widget

File

src/TwitterProfileInterface.php

<?php

namespace Drupal\twitter_profile_widget;

use Drupal\twitter_profile_widget\Entity\TwitterWidget;

/**
 * Interface TwitterProfileInterface.
 *
 * @package Drupal\twitter_profile_widget
 */
interface TwitterProfileInterface {

  /**
   * Pull tweets from the Twitter API.
   *
   * @param TwitterWidget $entity
   *   The called node entity.
   *
   * @return str[]
   *    An array of Twitter objects.
   */
  public function pull(TwitterWidget $entity);

  /**
   * Helper query to check whether the credentials are valid.
   *
   * @param string $key
   *    Twitter API key.
   * @param string $secret
   *    Twitter API secret.
   *
   * @return bool|string
   *    Whether or not the connection is valid. If error message, return that.
   */
  public function checkConnection($key = '', $secret = '');

}

Interfaces

Name	Description
TwitterProfileInterface	Interface TwitterProfileInterface.