Skip to content

Conversation

@AlmostMatt
Copy link
Contributor

Description

Provide details of the change, and generalize the change in the PR title above.


Testing

Describe how you've tested these changes. Link any manually triggered Integration tests or CPP binary SDK Packaging Github Action workflows, if applicable.


Type of Change

Place an x the applicable box:

  • Bug fix. Add the issue # below if applicable.
  • New feature. A non-breaking change which adds functionality.
  • Other, such as a build process or documentation change.

Notes

  • Bug fixes and feature changes require an update to the Release Notes section of release_build_files/readme.md.
  • Read the contribution guidelines CONTRIBUTING.md.
  • Changes to the public API require an internal API review. If you'd like to help us make Firebase APIs better, please propose your change in a feature request so that we can discuss it together.
@AlmostMatt AlmostMatt marked this pull request as draft August 31, 2022 16:31
@AlmostMatt AlmostMatt requested a review from a-maurice August 31, 2022 17:08
class AppCheck {
public:
/**
* Gets the instance of {@code AppCheck} associated with the given {@link
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(it's just firebase::App)


::firebase::app_check::AppCheckProvider* CreateProvider(
const ::firebase::App& app) override;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lint warning: Redundant blank line at the end of a code block should be deleted.

* FirebaseApp} instance, or creates one if none already exists.
*/
AppCheckProvider* CreateProvider(const App& app) override;
} No newline at end of file

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lint warning: Could not find a newline character at the end of the file.

virtual AppCheckProvider* CreateProvider(const App& app) = 0;
}

/// @brief Firebase App Check object.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lint warning: Line ends in whitespace. Consider deleting these extra spaces.

* the token or with an error code and error message.
*/
virtual void GetToken(
std::function<void(AppCheckToken, int, const std::string&)>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lint warning: Add #include <string> for string

* FirebaseApp} instance, or creates one if none already exists.
*/
AppCheckProvider* CreateProvider(const App& app) override;
} No newline at end of file

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lint warning: Could not find a newline character at the end of the file.

* FirebaseApp} instance, or creates one if none already exists.
*/
AppCheckProvider* CreateProvider(const App& app) override;
} No newline at end of file

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lint warning: Could not find a newline character at the end of the file.

* FirebaseApp} instance, or creates one if none already exists.
*/
AppCheckProvider* CreateProvider(const App& app) override;
} No newline at end of file

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lint warning: Could not find a newline character at the end of the file.

// limitations under the License.

/**
* Implementation of an {@link AppCheckProviderFactory} that builds {@link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: unable to resolve link to 'AppAttestCheckProvider' for \link command


/**
* Implementation of an {@link AppCheckProviderFactory} that builds {@link
* AppAttestCheckProvider}s. This is the default implementation.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: Unexpected end of comment while inside link command

*/
static AppAttestCheckProviderFactory* GetInstance();

/**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: unable to resolve link to 'AppCheckProvider' for \link command

static AppAttestCheckProviderFactory* GetInstance();

/**
* Gets the {@link AppCheckProvider} associated with the given {@link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: unable to resolve link to 'FirebaseApp' for \link command


/**
* Gets the {@link AppCheckProvider} associated with the given {@link
* FirebaseApp} instance, or creates one if none already exists.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: Unexpected end of comment while inside link command


/**
* Gets the {@link AppCheckProvider} associated with the given {@link
* FirebaseApp} instance, or creates one if none already exists.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: Unexpected end of comment while inside link command

public:
/**
* Gets an instance of this class for installation into a {@link
* firebase::app_check::AppCheck} instance.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: Unexpected end of comment while inside link command

completion_callback) = 0;
}

/** Interface for a factory that generates {@link AppCheckProvider}s. */

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: unable to resolve link to 'AppCheckProvider' for \link command

public:
virtual ~AppCheckProviderFactory();
/**
* Gets the {@link AppCheckProvider} associated with the given {@link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: unable to resolve link to 'FirebaseApp' for \link command

virtual ~AppCheckProviderFactory();
/**
* Gets the {@link AppCheckProvider} associated with the given {@link
* FirebaseApp} instance, or creates one if none already exists.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Documentation issue: warning: Unexpected end of comment while inside link command

@AlmostMatt AlmostMatt closed this Sep 27, 2022
@AlmostMatt
Copy link
Contributor Author

This PR was just to show the headers as part of the API proposal. A separate PR will merge the finalized headers.

@AlmostMatt AlmostMatt deleted the almostmatt-appcheck-api branch October 20, 2022 21:15
@firebase firebase locked and limited conversation to collaborators Oct 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

3 participants