react-native-fbsdk/src/models/FBShareOpenGraphValueContainer.js

Facebook SDK support for React Native apps.

/**
 * Copyright (c) 2015-present, Facebook, Inc. All rights reserved.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
 * copy, modify, and distribute this software in source code or binary form for use
 * in connection with the web services and APIs provided by Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use of
 * this software is subject to the Facebook Developer Principles and Policies
 * [http://developers.facebook.com/policy/]. This copyright notice shall be
 * included in all copies or substantial portions of the software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * @flow
 * @format
 */

'use strict';

import type {SharePhoto} from './FBSharePhoto';

type OpenGraphProperties = {[key: string]: OpenGraphValue};
type OpenGraphValue = {
  type: OpenGraphValueType,
  value: any,
};
type OpenGraphValueType = 'number' | 'open-graph-object' | 'photo' | 'string';

/**
 * Represents an interface for adding and retrieving values to open graph objects and actions.
 */
class ShareOpenGraphValueContainer {
  _properties: OpenGraphProperties;

  constructor(properties: ?OpenGraphProperties) {
    this._properties = properties ? properties : {};
  }

  /**
   * Sets a number for the specified key.
   */
  putNumber(key: string, number: number) {
    this._properties[key] = {type: 'number', value: number};
  }

  /**
   * Sets an open graph object for the specified key.
   */
  putObject(key: string, object: ShareOpenGraphValueContainer) {
    this._properties[key] = {type: 'open-graph-object', value: object};
  }

  /**
   * Sets a photo for the specified key.
   */
  putPhoto(key: string, photo: SharePhoto) {
    this._properties[key] = {type: 'photo', value: photo};
  }

  /**
   * Sets a string for the specified key.
   */
  putString(key: string, string: string) {
    this._properties[key] = {type: 'string', value: string};
  }

  /**
   * Gets an entry for the given key.
   */
  getEntry(key: string): OpenGraphValue {
    return this._properties[key];
  }
}

module.exports = ShareOpenGraphValueContainer;