search

aerogear / proposals

AeroGear Proposals
Apache License 2.0
0 stars 17 forks source link

Android sdk proposal #9

Closed secondsun closed 6 years ago

secondsun commented 6 years ago

Here is a new proposal for the Android SDK.

secondsun commented 6 years ago

I apologize in advance for typos and such. It is a late day commit :)

johnfriz commented 6 years ago

Can we add some detail on the structure / architecture of the Android SDK - e.g. what is required to add a new service.

Can we also add some info on how docs will be handled - Android API Docs and how they tie into the higher level service docs.

secondsun commented 6 years ago

@johnfriz Are you asking for technical docs (JavaDocs) or friendly docs (tutorials etc)? Is there a proposal for service docs I can reference?

wei-lee commented 6 years ago

Based on the discuss we had today, I think the following content can be added to this proposal:

  1. a high-level simple diagram to show the main modules that will be provided by MobileCore. The relationship between MobileCore and a service module (for example, IDM)
  2. For a service module, what interface it should implement/extend? What's the main functions/responsibility of the service module?
  3. For a service module, what's a typical constructor looks like?
  4. How to initialise/bootstrap the MobileCore? What the initialise/bootstrap function will be doing?
  5. How can developer get the implementation for a particular service? e.g. how can developer get the IdmService?
  6. How one service module can use another service module? e.g. how the sync service can use the IdmService to add token to the request?
secondsun commented 6 years ago

@wei-lee I couldn't get the class diagrams finished, but if you look here : https://github.com/secondsun/aerogear-android-sdk/tree/PoC I've stubbed the new information I've put into the proposal.

wei-lee commented 6 years ago

@secondsun let's added the diagram I created and clean up the proposal a little bit. Then I am happy to accept the proposal.

david-martin commented 6 years ago

Based on the discuss we had today, I think the following content can be added to this proposal:

a high-level simple diagram to show the main modules that will be provided by MobileCore. The relationship between MobileCore and a service module (for example, IDM) For a service module, what interface it should implement/extend? What's the main functions/responsibility of the service module? For a service module, what's a typical constructor looks like? How to initialise/bootstrap the MobileCore? What the initialise/bootstrap function will be doing?

@wei-lee I agree that having all of these in the proposal is desirable. I think most of that is in the proposal now

How can developer get the implementation for a particular service? e.g. how can developer get the IdmService? How one service module can use another service module? e.g. how the sync service can use the IdmService to add token to the request?

These ones could take some time to get right and may only 'come out in the wash'. I wouldn't see it as a problem if the proposal was merged without these fully figured out. That said, I like the idea of the Core providing the HTTP bit, and being able to supplement requests/responses/errors. That sounds like a core part of solving this.

david-martin commented 6 years ago

@secondsun can you review feedback from remaining open comments. We can merge if all comments have been addressed (either by explanation & agreement or by changes to the PR)

secondsun commented 6 years ago

@david-martin I'll fix the typos that @josemigallas picked out, I think that I have addressed @wtrocki 's comments, he and I can sync up on this.