joynr.messaging.webmessaging.WebMessagingAddress.js Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of libjoynr-js Show documentation

JOYnr JavaScript libjoynr-js

There is a newer version: 1.4.0

/*
 * #%L
 * %%
 * Copyright (C) 2011 - 2015 BMW Car IT GmbH
 * %%
 * Licensed 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.
 * #L%
 */

define("joynr/messaging/webmessaging/WebMessagingAddress", [ "joynr/util/Util"
], function(Util) {

    /**
     * @constructor WebMessagingAddress
     * @param {Object} settings the settings object for this constructor call
     * @param {Object} settings.window the default target window, the messages should be sent to
     * @param {String} settings.origin the default origin, the messages should be sent to
     */
    function WebMessagingAddress(settings) {
        Util.checkProperty(settings, "Object", "settings");
        Util.checkProperty(settings.window, "Object", "settings.window");
        Util.checkProperty(settings.origin, "String", "settings.origin");

        /**
         * @name WebMessagingAddress#getWindow
         * @function
         *
         * @returns {Window} the windows that should be addressed
         */
        this.getWindow = function getWindow() {
            return settings.window;
        };

        /**
         * @name WebMessagingAddress#getOrigin
         * @function
         *
         * @returns {String} the origin of the window that should be addressed
         * @see WebMessagingAddress#getWindow
         */
        this.getOrigin = function getOrigin() {
            return settings.origin;
        };
    }

    return WebMessagingAddress;

});