Skip to content
This repository was archived by the owner on Dec 5, 2019. It is now read-only.

[WIP] Deprecate getRoles function due to naming #78

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aidenkeating
Copy link
Contributor

Currently there is a function User#getRoles. This does not follow
the recommended naming convention for C# and does not follow the
naming conventions for the rest of the functions in the SDKs.

There is also a public field exposed on an instance of User named
Roles. This is not readonly and can be overwritten by an end user,
it exposes the list of roles that the user contains.

This change deprecates the function User#getRoles and recommends
to instead use the property Roles. It also refactors Roles from a
field into a readonly property without changing the return type
that the end user expects.

This means, apart from Roles no longer being modifiable for an end
user (which they shouldn't be doing anyway), the change is backwards
compatible.

Currently there is a function User#getRoles. This does not follow
the recommended naming convention for C# and does not follow the
naming conventions for the rest of the functions in the SDKs.

There is also a public field exposed on an instance of User named
Roles. This is not readonly and can be overwritten by an end user,
it exposes the list of roles that the user contains.

This change deprecates the function User#getRoles and recommends
to instead use the property Roles. It also refactors Roles from a
field into a readonly property without changing the return type
that the end user expects.

This means, apart from Roles no longer being modifiable for an end
user (which they shouldn't be doing anyway), the change is backwards
compatible.
@ziccardi
Copy link
Contributor

@aidenkeating Looks like this PR has been forgotten. Mind rebasing?

@danielpassos
Copy link
Contributor

@aidenkeating @ziccardi is this still valid?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants