features-extras.opensocial-payment.opensocial.js Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shindig-extras Show documentation

Provides extra, deprecated or extended functionality. The items here have unstable APIs and could change at any time.

There is a newer version: 3.0.0-beta4

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * 'License'); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */


/**
 * Requests the container to open a payment processor panel to show and submit
 * user's order. If the container does not support this method the callback 
 * will be called with a opensocial.ResponseItem. The response item will have 
 * its error code set to NOT_IMPLEMENTED.
 *
 * @param {opensocial.Payment} payment The Payment object.
 * @param {function(opensocial.ResponseItem)=} opt_callback The finishing
 *     callback function.
 */
opensocial.requestPayment = function(payment, opt_callback) {
  opensocial.Container.get().requestPayment(payment, opt_callback);
};

/**
 * Requests the container to open a payment records processor panel to list all
 * completed or incomplete payments of the user on current app and allowing 
 * users to fix the incomplete payments. If the container does not support 
 * this method the callback will be called with a opensocial.ResponseItem.
 * The response item will have its error code set to NOT_IMPLEMENTED.
 *
 * @param {function(opensocial.ResponseItem)=} opt_callback The finishing
 *     callback function.
 * @param {Object.=}
 *     opt_params Additional parameters to pass to the request.
 */
opensocial.requestPaymentRecords = function(opt_callback, opt_params) {
  opensocial.Container.get().requestPaymentRecords(opt_callback, opt_params);
};


/**
 * Creates a payment object.
 *
 * @param {Object.} params
 *    Parameters defining the payment object.
 * @return {opensocial.Payment} The new
 *     Payment object
 * @member opensocial
 */
opensocial.newPayment = function(params) {
  return opensocial.Container.get().newPayment(params);
};


/**
 * Creates a billing item object.
 *
 * @param {Object.} params
 *    Parameters defining the billing item object.
 * @return {opensocial.BillingItem} The new
 *     BillingItem object
 * @member opensocial
 */
opensocial.newBillingItem = function(params) {
  return opensocial.Container.get().newBillingItem(params);
};