001/**
002 *
003 * Copyright 2018 Paul Schaub.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.ox.callback.backup;
018
019public interface DisplayBackupCodeCallback {
020
021    /**
022     * This method is used to provide a client access to the generated backup code.
023     * The client can then go ahead and display the code to the user.
024     * The backup code follows the format described in XEP-0373 §5.3
025     *
026     * @see <a href="https://xmpp.org/extensions/xep-0373.html#backup-encryption">
027     *     XEP-0373 §5.4 Encrypting the Secret Key Backup</a>
028     *
029     *  @param backupCode backup code
030     */
031    void displayBackupCode(String backupCode);
032}